ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

DepartmentShiftAudits

Crud controller for fsdeptshiftaudits

API	Description
GET api/v1/departmentshiftaudits	Get a list of FsDeptShiftAuditsmodel
GET api/v1/departmentshiftaudits/{fsDeptShiftAuditID}	Get a FsDeptShiftAuditModel by primary key
PUT api/v1/departmentshiftaudits/{fsDeptShiftAuditID}	Update FsDeptShiftAuditModel by primary key
POST api/v1/departmentshiftaudits	Create a new FsDeptShiftAuditMode
DELETE api/v1/departmentshiftaudits/{fsDeptShiftAuditID}	Delete FsDeptShiftAuditModel by primary key

Schedule

API	Description
GET api/v1/schedule?StartDateTime={StartDateTime}&EndDateTime={EndDateTime}&DepartmentId={DepartmentId}&StaffId={StaffId}&ShowAll={ShowAll}
GET api/v1/schedule/secondaryapprovalschedules
GET api/v1/schedule/byfacility/{facilityId}/{startingFromDate}
POST api/v1/schedule/approve/{fsScheduleId}?approvalStatusTypeId={approvalStatusTypeId}&updatePostedPhaseOnAutoPost={updatePostedPhaseOnAutoPost}	Manager Approval of Schedule
GET api/v1/schedule/approvals/{fsScheduleId}	Get Schedule Approval data by ScheduleId
POST api/v1/schedule/triggerchangenotifications	Trigger schedule change notifications Called from Schedule Automation Job - process bulk requests
GET api/v1/schedule/GetAllOrienteesPreceptorsMatch?facilityId={facilityId}&departmentId={departmentId}	No documentation available.
GET api/v1/schedule/GetOrienteesPreceptorsMatchById?id={id}	No documentation available.
POST api/v1/schedule/UpdateOrienteesPreceptorsMatch	No documentation available.
POST api/v1/schedule/DeleteOrienteesPreceptorsMatch	No documentation available.
POST api/v1/schedule/reject/{scheduleId}	Reject schedule during approval phase
GET api/v1/schedule/status/{scheduleId}	No documentation available.

EmployeeTypes

API	Description
GET api/v1/employeetypes/GetEmployeeTypes	Returns a list of Employee Types
PUT api/v1/employeetypes/UpdateEmployeeTypes	Updates a list of Employee Types

DepartmentCompetencies

Crud controller for departmentcompetencies

API	Description
GET api/v1/departmentcompetencies/{departmentId}	Returns a lis of competency that has been associated to a particular department
POST api/v1/departmentcompetencies/{departmentId}
PUT api/v1/departmentcompetencies/{departmentCompetencyId}
DELETE api/v1/departmentcompetencies/{departmentCompetencyId}	Delete DepartmentCompetencyModel by primary key
GET api/v1/departmentcompetencies/targets?departmentId={departmentId}&scheduleStartDate={scheduleStartDate}&competencyId={competencyId}&scheduleEndDate={scheduleEndDate}	Get DepartmentSummaryCompetencies Scheduled and Targets for given ScheduleStart and ScheduleEnd Dates.

DeletedShiftTargets

Crud controller for deletedshifttargets

API	Description
GET api/v1/deletedshifttargets/{departmentId}/{effectiveDate}/{dayOfWeekId}	Get all Deleted Shifts by DepartmentId, EffectiveDate and Day of Week Id
DELETE api/v1/deletedshifttargets/{departmentId}/{shiftId}/{effectiveDate}/{dayOfWeekId}	Delete DeletedShift from shift Target by DepartmentId, ShiftId, EffectiveDate and Day of Week Id

StaffingExceptions

A Controller for dealing with staffing exceptions

API	Description
GET api/v1/staffingexceptions	Get a list of StaffingExceptions
GET api/v1/staffingexceptions/{staffingExceptionsId}	Get a StaffingException by primary key
PUT api/v1/staffingexceptions/{staffingExceptionsId}	Update StaffingException by primary key
POST api/v1/staffingexceptions	Create a new StaffingException
DELETE api/v1/staffingexceptions/{staffingExceptionsId}	Delete StaffingException by primary key
POST api/v1/staffingexceptions/Filter	Get exceptions filtered by department Id, summary Id, department skill id, and by dates

Cluster

Crud controller for clusters

API	Description
GET api/v1/dashboardconfig/clusters	Get a list of Clustersmodel. This is an asynchronous service.
GET api/v1/dashboardconfig/clusters/{clusterId}	Get a ClusterModel by primary key. This is an asynchronous service.
GET api/v1/dashboardconfig/clusters/byfacility/{facilityId}	No documentation available.
PUT api/v1/dashboardconfig/clusters/{clusterId}	Update ClusterModel by primary key. This is an asynchronous service.
POST api/v1/dashboardconfig/clusters	Create a new ClusterMode. This is an asynchronous service.
DELETE api/v1/dashboardconfig/clusters/{clusterId}	Delete ClusterModel by primary key. This is an asynchronous service.

WorkforcePlans

Crud controller for workforceplans

API	Description
POST api/v1/workforceplans/getworkforceplan	Get Work Force Plan. This is an asynchronous service.
POST api/v1/workforceplans/saveworkforceplan	Save a new Workforce Plan
POST api/v1/workforceplans/getstaffingeffectiveness	Get Staffing Effectiveness. This is an asynchronous service.

StaffShiftTrades

API for Staff Shift Trade operations.

API	Description
GET api/v1/staffshifttrades?IsDualSignOff={IsDualSignOff}&FsUserId={FsUserId}&CutoffDate={CutoffDate}&FsFacilityId={FsFacilityId}&FsDeptId={FsDeptId}&FsSkillLevelId={FsSkillLevelId}&StartDate={StartDate}&EndDate={EndDate}&AssignmentId={AssignmentId}&ReleaseTradeAction={ReleaseTradeAction}	Retrieve staffshifttrades that are available for manager approval
POST api/v1/staffshifttrades	Create a new StaffShiftTradeMode
POST api/v1/staffshifttrades/Approve	Manager Approve StaffShiftTrade
POST api/v1/staffshifttrades/Deny	Manager Deny StaffShiftTrade

NotificationResponseOptions

Crud controller for notificationresponseoptions

API	Description
GET api/v1/notificationresponseoptions	Get a list of NotificationResponseOptionsmodel
GET api/v1/notificationresponseoptions/{notificationResponseOptionId}	Get a NotificationResponseOptionModel by primary key
PUT api/v1/notificationresponseoptions/{notificationResponseOptionId}	Update NotificationResponseOptionModel by primary key
POST api/v1/notificationresponseoptions	Create a new NotificationResponseOptionMode
DELETE api/v1/notificationresponseoptions/{notificationResponseOptionId}	Delete NotificationResponseOptionModel by primary key

OptionTypes

API for Option Type Operations

API	Description
GET api/v1/OptionTypes/GetOptionValuesByType/{optionId}	Get a list of options by type. This is an asychronous service.
GET api/v1/OptionTypes/GetOptionValuesByTypeName/{optionType}	Get a list of option values by type name. This is an asychronous service.
GET api/v1/OptionTypes/GetTypesAndValuesByIds/{optionIds}	Get all options and values requested. This is an asychronous service.

ShiftCodeTemplateLinkedShifts

Crud controller for shiftcodetemplatelinkedshifts

API	Description
GET api/v1/shiftcodetemplatelinkedshifts	Get a list of ShiftCodeTemplateLinkedShiftsmodel
GET api/v1/shiftcodetemplatelinkedshifts/{shiftCodeTemplateLinkedShiftId}	Get a ShiftCodeTemplateLinkedShiftModel by primary key
PUT api/v1/shiftcodetemplatelinkedshifts/{shiftCodeTemplateLinkedShiftId}	Update ShiftCodeTemplateLinkedShiftModel by primary key
POST api/v1/shiftcodetemplatelinkedshifts	Create a new ShiftCodeTemplateLinkedShiftMode
DELETE api/v1/shiftcodetemplatelinkedshifts/{shiftCodeTemplateLinkedShiftId}	Delete ShiftCodeTemplateLinkedShiftModel by primary key
GET api/v1/shiftcodetemplatelinkedshifts/{departmentId}/{effectiveDate}/{dayOfWeekId}	Get all shift code template linked shifts by department id, effective date and day of week
POST api/v1/shiftcodetemplatelinkedshifts/{departmentId}/{shiftId}/{effectiveDate}/{dayOfWeekId}/{volumeLow}/{volumePeak}/{statDescription}	Add shift to shift code template linked shifts
DELETE api/v1/shiftcodetemplatelinkedshifts/{departmentId}/{shiftId}/{effectiveDate}/{dayOfWeekId}/{volumeLow}/{volumePeak}	delete from shift to shift code template linked shifts

ServiceLinesSkillSpecializationsMappings

Crud controller for servicelinesskillspecializationsmappings

API	Description
GET api/v1/servicelinesskillspecializationsmappings	Get a list of ServiceLinesSkillSpecializationsMappingsmodel
POST api/v1/servicelinesskillspecializationsmappings/AddUpdateMapping	Add or update ServiceLines Skill Specializations Mapping. This is an asynchronous service.
DELETE api/v1/servicelinesskillspecializationsmappings/Delete/{ServiceLinesSkillSpecializationsMappingId}	Delete ServiceLinesSkillSpecializationsMapping by Id. This is an asynchronous service.

OptionTypeValueLimits

API for Option Type Value Limit Operations

API	Description
GET api/v1/OptionTypeValueLimits/{optionType}/{optionTypeValue}/{fsFacilityId}	Get a list of OptionTypeValueLimitsmodel
GET api/v1/OptionTypeValueLimits/{optionTypeValueLimitID}	Get a OptionTypeValueLimitModel by primary key
PUT api/v1/OptionTypeValueLimits/{optionTypeValueLimitID}	Update OptionTypeValueLimitModel by primary key
POST api/v1/OptionTypeValueLimits	Create a new OptionTypeValueLimitMode
DELETE api/v1/OptionTypeValueLimits/{optionTypeValueLimitID}	Delete OptionTypeValueLimitModel by primary key

ScheduleClockInStatus

ScheduleClockIn Controller

API	Description
GET api/v1/scheduleclockinstatus/{departmentId}/{shiftDate}	Get clock in status of employees for a business day.

UserNotificationTemplates

UserNotificationTemplates Controller

API	Description
GET api/v1/usernotificationtemplates	Get a list of UserNotificationTemplatesmodel
GET api/v1/usernotificationtemplates/{userNotificationTemplateId}	Get a UserNotificationTemplateModel by primary key
PUT api/v1/usernotificationtemplates/{userNotificationTemplateId}	Update UserNotificationTemplateModel by primary key
POST api/v1/usernotificationtemplates	Create a new UserNotificationTemplateMode
DELETE api/v1/usernotificationtemplates/{userNotificationTemplateId}	Delete UserNotificationTemplateModel by primary key

PtoTransactions

Crud controller for ptotransactions

API	Description
GET api/v1/ptotransactions/{startDate}	Retrieve PTO balance for authenticated staff.
GET api/v1/ptotransactions/{staffId}/{startDate}	Retrieve PTO balance
POST api/v1/ptotransactions	Create / Update PtoTransaction if PTO. This is an asynchronous service
DELETE api/v1/ptotransactions/{assigmentId}	Delete PtoTransaction. This is an asynchronous service

Facilities

API related to Facilities

API	Description
GET api/v1/facilities/{page}/{pageSize}	Returns a list of facilities for the specified "page" of size "pageSize". This is an asynchronous service.
GET api/v1/facilities/GetAllFacilitiesKvp	Get list of all the facilities as key value pair. This is an asynchronous service.
GET api/v1/facilities/{facilityId}	Returns information about a facility. This is an asynchronous service.
GET api/v1/facilities/keypairs	Get Facilities for dropdowns. This is an asynchronous service.
GET api/v1/facilities/GetClusteredFacilities	Get list of facilities by facility cluster. This is an asynchronous service.
GET api/v1/facilities/GetByUser/{fsUserID}	Get facilities fo user. This is an asynchronous service.
GET api/v1/facilities/ResearchFacility	Get all facilities for division. This is an asynchronous service.
GET api/v1/facilities/SkillConfig/{facilityid}	Get All Facility Skill Configuration values for a facility. This is an asynchronous service.
PUT api/v1/facilities	Updates a facility This is an asynchronous service.
POST api/v1/facilities/SkillConfigUpdate	update the FacilitySkillConfiguration values based on FacilitySkillConfigurationId.
GET api/v1/facilities/StaffReports	For User Returns a list of Facilities that user/staff has access to based on his "ThreeFourId" and Facilities that have "IsActivateStaffReports" is "True" from the "FsFacilityConfig" table
PUT api/v1/facilities/{facilityId}/schedules/move?doSave={doSave}	Move schedules of given departments to next phase. If list of departments are not passed in, all the departments belonging to this facility will be processed

Departments

API for Department operations.

API	Description
POST api/v1/departments	Creates a new Department
PUT api/v1/departments	Updates the department information
GET api/v1/departments/active/byfacility/{facilityId}	Returns a list of active departments for a given facility.
GET api/v1/departments/byfacility/{facilityId}	Returns a list of all departments for a given facility.
GET api/v1/departments/{departmentId}	Returns a department for the given department Id. This is an asynchronous service.
GET api/v1/departments/userdefault/{userId}	Returns the default department for a given user Id.
GET api/v1/departments/user/{userId}	Returns a list of Departments that the User belongs to
GET api/v1/departments/byuser/{userId}	Returns a list of Departments that the User belongs to
GET api/v1/departments/userdepartmentgroups/{userId}	No documentation available.
GET api/v1/departments/staffreport	Returns a list of departments and facilities by logged in staff/logged in User. This is an asynchronous service.
GET api/v1/departments/GetDepartmentsByFacilityKvp/{facilityId}	Get list of all the departments in a facility as key value pair. This is an asynchronous service.
POST api/v1/departments/ResearchDepartments	Research Departments by code, hr department code, admission department number or description. This is an asynchronous service.
GET api/v1/departments/SearchByCode/{departmentCode}	Type ahead search by department code. This is an asynchronous service.
GET api/v1/departments/userdepartment/{userId}/{facilityId}	For User Returns a list of departments that he has Access to for the selected Facility
GET api/v1/departments/StaffReports/{facilityId}	For User/Staff Returns a list of departments that he has Access to for the selected Facility
DELETE api/v1/departments/{departmentId}	Deletes the Department
GET api/v1/departments/GetAllDepartments	Get all departments.
GET api/v1/departments/bycoid/{coid}/{departmentHRCodes}/{translationMode}	returns list of departments for the specified facility coid
GET api/v1/departments/{departmentId}/summaryeffectivedates	Get distinct department summary effective dates for given deptId This is an asynchronous service.
POST api/v1/departments/DepartmentsSearch	Get All Departments by Search criteria This is an asynchronous service.
GET api/v1/departments/GetSchedulePhases/{deptId}/{year}	No documentation available.
GET api/v1/departments/GetSchedulePhases/{scheduleId}?schdueleId={schdueleId}	No documentation available.
POST api/v1/departments/SaveSchedulePhases	No documentation available.

StaffSkills

Employee Skills API

API	Description
POST api/v1/staffskills/{staffId}/{skillLevelId}/{isPrimarySkill}	Add a skill to a staff member
GET api/v1/staffskills/{staffId}	Retrieves a list of skill levels for the provided Staff
PUT api/v1/staffskills/{staffId}/{skillLevelId}/{isPrimarySkill}	Sets the IsPrimarySkill of a staff's skill
DELETE api/v1/staffskills/{staffId}/{skillLevelId}	Removes a Staff's Skill

UserNotificationDetails

Crud controller for UserNotificationDetails

API	Description
GET api/usernotificationdetails	Get a list of UserNotificationDetailsmodel
GET api/usernotificationdetails/{userNotificationDetailId}	Get a UserNotificationDetailModel by primary key
PUT api/usernotificationdetails/{userNotificationDetailId}	Update UserNotificationDetailModel by primary key
POST api/usernotificationdetails	Create a new UserNotificationDetailMode
DELETE api/usernotificationdetails/{notificationResponseOptionId}	Delete NotificationResponseOptionModel by primary key

ScheduleFormats

API for schedule format operations.

API	Description
GET api/v1/scheduleformats/GetSchedulePeriods/{departmentId}/{includeCurrentSchedulePeriod}/{numberofSchedules}	Get department schedule start and end dates.
GET api/v1/scheduleformats/GetFacilitySchedulePeriods/{facilityId}/{includeCurrentSchedulePeriod}/{numberofSchedules}	Get Facility Schedules' Start and End Dates..
GET api/v1/scheduleformats/GetUserDepartmentGroupSchedulePeriods/{userDepartmentGroupId}/{includeCurrentSchedulePeriod}/{numberofSchedules}	Get User Department Group Schedules' Start and End Dates.. ///
GET api/v1/scheduleformats/GetSchedulePeriodsPastAndFuture/{departmentId}/{includeCurrentSchedulePeriod}/{numberofSchedules}	Get department schedule start and end dates.

DistributionLists

Crud controller for subscriptionplans

API	Description
GET api/v1/distributionlists	Get all Distribution Lists
GET api/v1/distributionlists/byfacility/{facilityId}	Gets all Distribution Lists for a Facility
POST api/v1/distributionlists	Create a Distribution List
DELETE api/v1/distributionlists/{distributionListId}	Deletes a Distribution List by primary key

SkillLevel

API for skill level operations.

API	Description
GET api/v1/SkillLevel/ByDepartment/{departmentId}/{date}	Retrieves Skill Levels by Department
GET api/v1/SkillLevel/{page}/{pageSize}	Retrieves All Skill Levels
POST api/v1/SkillLevel/search	Returns a list of Skill Levels based on search criteria sorted by sort criteria. This is an asynchronous service.
GET api/v1/SkillLevel/bystaff/{staffId}	Get SkillLevels by staffId This is an asynchronous service.
GET api/v1/SkillLevel/forstaff/{staffId}	Get SkillLevels for staff This is an asynchronous service.
GET api/v1/SkillLevel/foruser/{userId}/{facilityId}	Get SkillLevels for user for that perticular facility This is an asynchronous service.
GET api/v1/SkillLevel/StaffReports/{facilityId}	Get SkillLevels for user for that perticular facility This is an asynchronous service.
POST api/v1/SkillLevel/staffskillcoverage	Get SkillLevels for staff/ User by Departments This is an asynchronous service.
POST api/v1/SkillLevel/GetSkillsByDepartmentIds	Returns department skills for a list of departments This is an asynchronous service.

StaffAlertConfigs

Staff Alerts configurations Controller

API	Description
POST api/v1/staffalertconfigs/activatephone	Activate a staff's mobile number
POST api/v1/staffalertconfigs/validateactivationcode	Validate mobile phone activation code
GET api/v1/staffalertconfigs/{staffId}	Get a staff's alert configuration
POST api/v1/staffalertconfigs/getbystaffIds	Get alert configurations given a list of StaffIds
POST api/v1/staffalertconfigs	Save a staff's alert configuration
PUT api/v1/staffalertconfigs	Update a staff's alert configuration
GET api/v1/staffalertconfigs/notificationevents	Get notification events

SubscriptionPlans

Crud controller for subscriptionplans

API	Description
GET api/v1/subscriptionplans	Get a list of Subscription Plans This is an asynchronous service.
POST api/v1/subscriptionplans	Create a Subscription Plan
DELETE api/v1/subscriptionplans/{subscriptionPlanId}	Delete a Subscription Plan by primary key

Staffs

Staff API V1

API	Description
POST api/v1/staffs/GetStaffNotAssigned	Get list of staff by department with no active assignment for date. This is an asynchronous service.
GET api/v1/staffs/GetStaffAssociations/{staffId}	Get primary and secondary department associations for staff member. This is an asynchronous service.
GET api/v1/staffs/StaffSearch?EmployeeTypeId={EmployeeTypeId}&LastName={LastName}&FirstName={FirstName}&DepartmentId={DepartmentId}&FacilityId={FacilityId}&SkillLevelId={SkillLevelId}&Username={Username}&Ein={Ein}&Fte={Fte}&StartDate={StartDate}&Phone={Phone}&Email={Email}	Get list of staff filters by FirstName, LastName, EIN or ThreeFourID This is an asynchronous service.
POST api/v1/staffs/GetStaffSearch	Get list of staff by name, department, ein, phone etc. to prevent creating duplicate staff entries.
GET api/v1/staffs/findmatching?Ein={Ein}&UserName={UserName}&FirstName={FirstName}&LastName={LastName}&StaffId={StaffId}	Gets a list of staff that match given Ein, UserName, FirstName, LastName This is an asynchronous service.
GET api/v1/staffs/findprofilescontaining?matchTerm={matchTerm}	Gets a list of staff whose profiles contain the term to match. Staff Ein, UserName, FirstName, LastName are used to perform the search This is an asynchronous service.
POST api/v1/staffs/{staffId}/reactivate	Remove End-Date and move staff to Parallon facility
GET api/v1/staffs/{staffId}/isstaffportaluser	Gets the Staff IsStaffPortalUser flag
POST api/v1/staffs/{staffId}/isstaffportaluser	Sets the Staff IsStaffPortalUser flag

ContractLaborShifts

API	Description
GET api/v1/contractlaborshifts?FacilityId={FacilityId}&DepartmentId={DepartmentId}&StartDate={StartDate}&EndDate={EndDate}&WfFolderGroupId={WfFolderGroupId}&SkillId={SkillId}&StatusId={StatusId}&AssignmentId={AssignmentId}&StatusIds={StatusIds}&CreatedByUserId={CreatedByUserId}&FromCreatedOnDateUtc={FromCreatedOnDateUtc}&ToCreatedOnDateUtc={ToCreatedOnDateUtc}&FilterByNeeds={FilterByNeeds}	Retrieve a list of contract labor requests
GET api/v1/contractlaborshifts/status	Return list of contract labor request's statuses
PUT api/v1/contractlaborshifts/{contractLaborShiftId}/cancel	Cancel a particular contract labor request
PUT api/v1/contractlaborshifts/cancelByAssignment/{assignmentId}	Cancel a particular contract labor request associated to an assignment
PUT api/v1/contractlaborshifts/{contractLaborShiftId}/schedule	Add a contract labor resource to the schedule
POST api/v1/contractlaborshifts	Create a request for a contract labor resource
PUT api/v1/contractlaborshifts/{contractLaborShiftId}/confirm	Accept or confirm a particular contract labor resource
GET api/v1/contractlaborshifts/cancelreasons	Retrieve contract labor cancel reasons
GET api/v1/contractlaborshifts/byAssignment/{assignmentId}	Retrieve a contract labor shift associated to an assignment
GET api/v1/contractlaborshifts/byUserDepartments?statusIds={statusIds}&fromRequestdate={fromRequestdate}	Fetch contract labor requests created in any department(s) associated with the authenticated user, which are in certain statuses
PUT api/v1/contractlaborshifts/cancelassignment	Cancel assignment when shift is canceled in Workforce. Called from job: FS.ETL Work Force action
PUT api/v1/contractlaborshifts/{contractLaborShiftId}/assignstaff	Assign a staff to a contract labor shift
POST api/v1/contractlaborshifts/{contractLaborShiftId}/resubmit
POST api/v1/contractlaborshifts/cancel
POST api/v1/contractlaborshifts/bulk	Create request for contract labor resources in bulk for multiple departments
POST api/v1/contractlaborshifts/generateFromOpenNeeds	Auto-generate contract labors shifts base on unfulfilled open needs for any department with a posted schedule in the future
POST api/v1/contractlaborshifts/workforcerequeststatus	Let the list of Workforce Request Status
GET api/v1/contractlaborshifts/ContractLaborAutomationReport	Get auto-generated contract labors shifts report
GET api/v1/contractlaborshifts/GetWfLimits	Get auto-generated contract labors shifts Limits

DailyRosterFilter

API	Description
GET api/v1/DailyRosterFilter/{userId}	Returns all cancel reasons.
POST api/v1/DailyRosterFilter	Simple model for saving
PUT api/v1/DailyRosterFilter	Simple model for updating
DELETE api/v1/DailyRosterFilter/{fsUserDeptGroupId}	Simple model for deleting

Competencies

API	Description
GET api/v1/competencies?DepartmentId={DepartmentId}&AssociatedOnly={AssociatedOnly}
GET api/v1/competencies/{competencyId}

FacilitySchedulePeriod

API related to Facility Schedule Periods

API	Description
POST api/v1/facilityscheduleperiod/GetFutureSchedulePeriods	Get future schedule periods
GET api/v1/facilityscheduleperiod/GetFacilitySchedulePhases/{facilityId}	Get future schedule periods
POST api/v1/facilityscheduleperiod/SaveFacilitySchedulePhases	Get future schedule periods

ShiftTrades

API for shift trade operations.

API	Description
PUT api/v1/shifttrades	Deny a request for a shift trade.
PUT api/v1/shifttrades/ApproveTradeRequest	Approve staff trade assignment request This is an asynchronous service.
POST api/v1/shifttrades/GetAllTrades	Get all shift trades ( pending, approved or denied ) for a given date range by Department, Facility and/or Skill Level
GET api/v1/shifttrades/PotentialTrades/{assignmentId}?offset={offset}&pagesize={pagesize}	Get potential trades for given assignmentId

UserNotifications

UserNotifications Controller

API	Description
GET api/v1/usernotifications	Get a list of UserNotificationsmodel
GET api/v1/usernotifications/{userNotificationId}	Get a UserNotificationModel by primary key
PUT api/v1/usernotifications/{userNotificationId}	Update UserNotificationModel by primary key
POST api/v1/usernotifications	Create a new UserNotificationMode
DELETE api/v1/usernotifications/{userNotificationId}	Delete UserNotificationModel by primary key
GET api/v1/usernotifications/{userId}/{staffId}/{startDate}	Returns notifications for the user based on start date. This is an asynchronous service.

StaffNotes

API	Description
GET api/v1/staffnotes/GetStaffNotesByStaffId/{staffId}	Retrieves the staff's notes for the specified staff Id

NeedsAggregationMetrics

API	Description
GET api/v1/needsaggregationmetrics/{departmentId}/{startDateTime}/{endDateTime}	Get department metrics. This is an asynchronous service.
GET api/v1/needsaggregationmetrics/departments/{departmentIds}/{startDateTime}/{endDateTime}	Get departments metrics the departmentids must be comma separated integers. This is an asynchronous service.
GET api/v1/needsaggregationmetrics/departmentsbyskilllevel/{departmentIds}/{startDateTime}/{endDateTime}/{skillLevelId}	Get departments metrics the departmentids must be comma separated integers. This is an asynchronous service.
GET api/v1/needsaggregationmetrics/byskilllevel/{departmentId}/{startDateTime}/{endDateTime}/{skillLevelId}	Get department metrics by skill level. This is an asynchronous service.
GET api/v1/needsaggregationmetrics/ByShiftTarget/{departmentId}/{startDateTime}/{endDateTime}/{skillLevelId}	Get departments shift target metrics. This is an asynchronous service.

Needs

API for Need operations.

API	Description
GET api/v1/needs/{needId}	Get need by id.
GET api/v1/needs/booked	Get pending (booked) open need requests for authenticated staff.
POST api/v1/needs/{needId}/request	Book an open need.
POST api/v1/needs/{needId}/withdraw	Remove open need request.
POST api/v1/needs/createopenneed/{departmentId}/{startDateTime}/{endDateTime}/{skillLevelId}/{deptShiftId}	Creates an open need. This is an asynchronous service.

PatientClassificationRatingDetails

Crud controller for patientclassificationratingdetails

API	Description
GET api/v1/pcsdetails	Get a list of FsPatientClassificationRatingDetailsmodel
GET api/v1/pcsdetails/{fsPatientClassificationRatingDetailID}	Get a FsPatientClassificationRatingDetailModel by primary key
PUT api/v1/pcsdetails/UpdateList	Update a list of Patient Classification Rating Details.

DepartmentPreferences

API for Department Preferences operations.

API	Description
GET api/v1/departmentpreferences/{departmentId}	Returns preference settings for a given department.
POST api/v1/departmentpreferences	Updates staff preference for a department

DashboardConfigs

Crud controller for dashboards

API	Description
GET api/v1/dashboardconfig/dashboards	Get a list of Dashboardsmodel. This is an asynchronous service.
GET api/v1/dashboardconfig/dashboards/{dashboardId}	Get a DashboardModel by primary key. This is an asynchronous service.
PUT api/v1/dashboardconfig/dashboards/{dashboardId}	Update DashboardModel by primary key. This is an asynchronous service.
POST api/v1/dashboardconfig/dashboards	Create a new DashboardMode. This is an asynchronous service.
DELETE api/v1/dashboardconfig/dashboards/{dashboardId}	Delete DashboardModel by primary key. This is an asynchronous service.

SurgeAlertPreferences

API	Description
GET api/v1/surgealertpreferences/{tenantId}/{userId}/{searchArgument}	List SurgeAlert Preferences for multiple facilities
POST api/v1/surgealertpreferences	Create surge alert preference based on facility,user and department name
DELETE api/v1/surgealertpreferences/{surgeAlertPreferenceId}	Delete surge alert preference with a particular Id
POST api/v1/surgealertpreferences/{tenantId}/{userId}	This will Save and delete multiple surge alert preferences

ContractLaborTransactionLogs

Crud controller for contractlabortransactionlogs

API	Description
GET api/v1/contractlabortransactionlogs	Get a list of ContractLaborTransactionLogsmodel
GET api/v1/contractlabortransactionlogs/{contractLaborTransactionLogId}	Get a ContractLaborTransactionLogModel by primary key
PUT api/v1/contractlabortransactionlogs/{contractLaborTransactionLogId}	Update ContractLaborTransactionLogModel by primary key
POST api/v1/contractlabortransactionlogs	Create a new ContractLaborTransactionLogMode
DELETE api/v1/contractlabortransactionlogs/{contractLaborTransactionLogId}	Delete ContractLaborTransactionLogModel by primary key
GET api/v1/contractlabortransactionlogs/search?FsUserId={FsUserId}&FromCreatedOnDateUtc={FromCreatedOnDateUtc}&ToCreatedOnDateUtc={ToCreatedOnDateUtc}	Get a ContractLaborTransactionLogs filtered by search criteria

CancelReasons

API for cancel reasons operations.

API	Description
GET api/v1/cancelreasons	Returns all cancel reasons.
GET api/v1/cancelreasons/config	Retruns the Configuration for the current division with associations
POST api/v1/cancelreasons/config	Retruns the Configuration for the current division with associations
POST api/v1/cancelreasons/reason	Save Reason
DELETE api/v1/cancelreasons/reason/{cancelReasonId}	Delete Cancel Reason
POST api/v1/cancelreasons/associations	Save Department association
DELETE api/v1/cancelreasons/associations/{cancelReasonId}	Deletes all associations for a particular Cance Reason
POST api/v1/cancelreasons/category	Save a Cancelation Reason Category
POST api/v1/cancelreasons/categories	Save Exclude from Reborting and Enabled config for all the reasons
DELETE api/v1/cancelreasons/categories/{categoryId}	Delete a Cancellation Category
GET api/v1/cancelreasons/department/{departmentId}	Returns enabled cancel reasons for a department
GET api/v1/cancelreasons/department/{departmentId}/category/{categoryId}	Returns Cancel Reasons for a given Department and Category
GET api/v1/cancelreasons/original	Returns the original Cancel reasons, used when Feature Toggle is off
POST api/v1/cancelreasons/departments	Returns cancel reason departments for a List of department IDs
GET api/v1/cancelreasons/ByFacility/{facilityId}	Get Cancellation Reasons by Facility
POST api/v1/cancelreasons/departmentsReasonsUpdate	Simple model for saving
GET api/v1/cancelreasons/categories/department/{departmentId}	Gets All Categories enabled by a given deparment

KeyValues

Common pair values for populating menus and etc

API	Description
GET api/v1/KeyValues/GetFaclilitiesAsync	Returns all the facilities. This is an asynchronous service.
GET api/v1/KeyValues/GetDepartmentsAsync	Returns the list of departments to display. This is an asynchronous service.
GET api/v1/KeyValues/Departments/{facilityId}	Returns a list of departments for the facility, if not specified will return all departments. This is an asynchronous service.
GET api/v1/KeyValues/GetAllSkillsAsync	Returns the list of all skills in every department. This is an asynchronous service.
GET api/v1/KeyValues/SearchSkillsAsync/{description}	Return a list of skills to display in the skills table by short or long description. This is an asynchronous service.
GET api/v1/KeyValues/GetSkillsAsync/{departmentId}/{effectiveDate}	Return a list of skills to display in the department at specified Time. This is an asynchronous service.
GET api/v1/KeyValues/GetCancelReasonsAsync	Returns a list of Cancel Reasons. This is an asynchronous service.
GET api/v1/KeyValues/EmployeeTypesAsunc	Returns all employee types. This is an asynchronous service.

DailyRoster

API	Description
POST api/v1/DailyRoster/compressed	Get Dashboard Metrics. This is an asynchronous service.
POST api/v1/DailyRoster/CompressedRosterByDay	Get compressed roster by day This is an asynchronous service.
POST api/v1/DailyRoster/CareAssignmentRosterByDay	Get CareAssignment roster by day This is an asynchronous service.
POST api/v1/DailyRoster/ExpandedRosterByDay	Get expanded roster by day This is an asynchronous service.
POST api/v1/DailyRoster/GetDailyRosterFilterBreakdown	Get daily roster filter breakdown by businessday. This is an asynchronous service.

ContractLabor

API	Description
GET api/v1/contractlabor/skillspecialization/{facilityCOID}/{departmentCode}	Get skill and specialization for particular department
GET api/v1/contractlabor/contractImports/{userName}/{coid}

Mt

Test methods for MultiTenancy API proxy calls.

API	Description
GET api/v1/admin/mt/clients
GET api/v1/admin/mt/tenant-databases
GET api/v1/admin/mt/refreshtoken/{tokenId}
POST api/v1/admin/mt/refreshtoken

NeedNotes

API for Need Note operations.

API	Description
DELETE api/v1/NeedNotes/{needNoteId}	Delete specific Need Note.
GET api/v1/NeedNotes/{needNoteId}	Returns a specific Need Note. This is an asynchronous service.
GET api/v1/NeedNotes/FindByAssignmentAsync/{assignId}	Returns a list of Need Notes associated with an Assignment. This is an asynchronous service.
POST api/v1/NeedNotes	Creates a new Need Note
PUT api/v1/NeedNotes	Updates a specific Need Note.

SecondaryDepartments

API for Secondary Department operations

API	Description
POST api/v1/SecondaryDepartments	Create a new staff secondary department association.
POST api/v1/SecondaryDepartments/UnassociatedSecondaryStaff	Get All Unassociated Secondary Staff details This is an asynchronous service.
DELETE api/v1/SecondaryDepartments/update/{associationId}/{expiresDateUtc}	Update expires date to do soft delete. This is an asynchronous service.
POST api/v1/SecondaryDepartments/ModifyStaffAssociations	Create or remove for list of staff secondary associations for a staff.

EmployeePreferences

API	Description
GET api/v1/employeepreferences/{employeePreferenceId}
PUT api/v1/employeepreferences/{employeePreferenceId}	Update a particular employee preference

Reports

Crud controller for userstaffpreferences

API	Description
GET api/v1/Reports/GetReportCollection	Get FS Application report collection

Requests

PTO Requests

API	Description
DELETE api/v1/requests/{requestId}	Cancel pending request.
GET api/v1/requests?StaffId={StaffId}&Start={Start}&End={End}&Status={Status}	Get requests by the search criteria
GET api/v1/requests/assignments?StaffId={StaffId}&Start={Start}&End={End}&Status={Status}	Get requests by the search criteria formatted as AssignmentModel
POST api/v1/requests	Create a PTO request.

ScheduleOptimizeRequests

API for Schedule Optimize Request Operations

API	Description
GET api/v1/scheduleoptimizerequests	Get a list of ScheduleOptimizeRequestsmodel
GET api/v1/scheduleoptimizerequests/{scheduleOptimizeRequestId}	Get a ScheduleOptimizeRequestModel by primary key
PUT api/v1/scheduleoptimizerequests	Update ScheduleOptimizeRequest by OptimizeScheduleRequestModel
POST api/v1/scheduleoptimizerequests	Create a new ScheduleOptimizeRequest by OptimizeScheduleRequestModel
POST api/v1/scheduleoptimizerequests/{scheduleId}?partofdayId={partofdayId}	Run Helper for given ScheduleId
DELETE api/v1/scheduleoptimizerequests/{scheduleOptimizeRequestId}	Delete ScheduleOptimizeRequestModel by primary key
PUT api/v1/scheduleoptimizerequests/Cancel/{scheduleOptimizeRequestId}	Cancel ScheduleOptimizeRequest by scheduleId
GET api/v1/scheduleoptimizerequests/GetLastRunDetails/{scheduleId}	Get Last Run Details by scheduleId
GET api/v1/scheduleoptimizerequests/UndoEligible/{scheduleId}	Undo Schedule Optimize Request by scheduleId
PUT api/v1/scheduleoptimizerequests/Undo/{scheduleId}	Undo Schedule Optimize Request by scheduleId
GET api/v1/scheduleoptimizerequests/HelperRunFilterOptions?departmentId={departmentId}&scheduleStartDate={scheduleStartDate}&scheduleEndDate={scheduleEndDate}	Get Filter Options by departmentId, scheduleStartDate and scheduleEndDate for manual Schedule Helper Run

DepartmentSummaries

API	Description
GET api/v1/departmentsummaries/keypairs/{departmentIds}	This is an asynchronous service.
GET api/v1/departmentsummaries/current/{departmentIds}/{currentDateTime}	Get summary per current date. This is an asynchronous service.
GET api/v1/departmentsummaries/currentbycluster/{clusterIds}/{currentDateTime}	Get summary per current date. This is an asynchronous service.
GET api/v1/departmentsummaries/effectivedates/{departmentId}	Get distinct department summary effective dates for given deptId This is an asynchronous service.
GET api/v1/departmentsummaries/{departmentId}/summaryeffectivedate/{effectiveDate}	Get department summaries given DepartmentId and Effective Date This is an asynchronous service.
GET api/v1/departmentsummaries/getDepartmentOffSetTime/{departmentId}/{effectiveDate}	Get department fisrt summary start time.

StaffAvailabilities

Staff Availabilities Controller

API	Description
GET api/v1/staffavailabilities/{staffId}	Retrieves a Staff's Availability for the specified Staff Id
GET api/v1/staffavailabilities/unavailable/{staffId}	Retrieves a Staff's Un-Availability for the specified Staff Id
POST api/v1/staffavailabilities	Add a Staff's Availibity
POST api/v1/staffavailabilities/unavailable	Add staff's Un-Availabilities
PUT api/v1/staffavailabilities/{staffAvailabilityId}	Updates a Staff's Availibity
DELETE api/v1/staffavailabilities/{staffAvailabilityId}	Delete a Staff's Availability
GET api/v1/staffavailabilities/{departmentId}/{startDate}/{endDate}/{staffId}	Retrieve Staff Availabilities by department. This is an asynchronous service.
GET api/v1/staffavailabilities/unavailable/{departmentId}/{startDate}/{endDate}/{staffId}	Retrieve Staff Un-Availabilities by department. This is an asynchronous service.

ScheduleMetricScore

API for Schedule Metric Scores.

API	Description
POST api/v1/schedulemetricscore/GetScheduleMetricScores	Get Schedule Metric Scores
GET api/v1/schedulemetricscore/GetScheduleMetricScores/{scheduleId}	No documentation available.
GET api/v1/schedulemetricscore/BalancingPhase/{scheduleId}	Get Schedule Metric Scores for balancing phase
GET api/v1/schedulemetricscore/UnderCommitmentStaff/{scheduleId}	Get under commitment staff in balancing phase

Holidays

Crud controller for holidays

API	Description
GET api/v1/schedule/holidays	Get a list of Holidaysmodel
GET api/v1/schedule/holidays/{holidayID}	Get a HolidayModel by primary key
PUT api/v1/schedule/holidays/{holidayID}	Update HolidayModel by primary key
POST api/v1/schedule/holidays	Create a new HolidayMode
DELETE api/v1/schedule/holidays/{holidayID}	Delete HolidayModel by primary key

DepartmentMatrix

API for Department Matrix operations.

API	Description
GET api/v1/departmentmatrix/bydate/{departmentId}/{lookUpDate}	Get Staffing matrix. This is an asynchronous service. This is an asynchronous service.
GET api/v1/departmentmatrix/bysummaryperiod/{departmentId}/{lookUpDateTime}/{deptPatientClassificationRangeId}	Get Staffing matrix. This is an asynchronous service. This is an asynchronous service.
GET api/v1/departmentmatrix/SkillsNoTarget/{departmentId}/{effectiveDate}	Get skill level ids from matrix with zero target. This is an asynchronous service.
GET api/v1/departmentmatrix/dashboard/{departmentId}/{lookUpDate}	This is an asynchronous service.
GET api/v1/departmentmatrix/deptmatrix/{departmentId}/{deptSummaryId}/{lookUpDate}

Dashboards

API	Description
GET api/v1/Dashboards/config/{dashboardId}/{currentDateTime}	Get Dashboard configuration. This is an asynchronous service.
POST api/v1/Dashboards/initial/{dashboardId}/{currentDateTime}	Get Dashboard initial load. This is an asynchronous service.
POST api/v1/Dashboards/metrics	Get Dashboard Metrics. This is an asynchronous service.
POST api/v1/Dashboards/filters	Get Dashboard Filters. This is an asynchronous service.
GET api/v1/Dashboards/filters/{dashboardId}/{currentDateTime}	Get Dashboard configuration. This is an asynchronous service.
DELETE api/v1/Dashboards/config/{dashboardId}/{currentDateTime}	Deletes Dashboard configuration. This is an asynchronous service.
GET api/v1/Dashboards/{dashboardId}/{userId}/preferences/filters	No documentation available.
GET api/v1/Dashboards/{dashboardId}/{userId}/preferences/surge	No documentation available.
POST api/v1/Dashboards/{dashboardId}/{userId}/preferences/filters	No documentation available.
POST api/v1/Dashboards/{dashboardId}/{userId}/preferences/surge	No documentation available.
PUT api/v1/Dashboards/{dashboardId}/{userId}/preferences/filters/{filterId}	No documentation available.
DELETE api/v1/Dashboards/{dashboardId}/{userId}/preferences/filters/{filterId}	No documentation available.
POST api/v1/Dashboards/GetCalloutAndContractlaborStaffByDepartments	Get Contact Labor and Callout Staff details

Census

DepartmentTab Census Controller

API	Description
PATCH api/v1/Census	UpdateCensus - Updates Forecast Census. This is an asynchronous service.
GET api/v1/Census/StaffTo/{censusId}	Returns the StaffTo of a censusId. This is an asynchronous service.
GET api/v1/Census/GetByDepartmentAsync/{departmentId}/{startDate}	Get census by department and start date. This is an asynchronous service.
GET api/v1/Census/ForecastByDepartment/{departmentId}/{starttime}/{date}	Census forecast by department.
GET api/v1/Census/Forecast/{forecastId}	Returns the Forecast Census of a forecast censusId. This is an asynchronous service.
PUT api/v1/Census/GetCensusForSummaryPeriod	Returns the department summaries for display for the time interval of daily roster. This is an asynchronous service.
POST api/v1/Census/UpdateCensusForSummaryPeriod	Updates the department summaries for display for the time interval of daily roster. This is an asynchronous service.
GET api/v1/Census/bycoid/{coId}/{date}/{numberOfDays}/{departmentHRCodes}/{translationMode}	returns Forecast Census values by coId
GET api/v1/Census/patientclassificationrange/{departmentId}/{effectiveDate}	returns Patient Range Models by departmentId, EffectiveDate
POST api/v1/Census/getforecastcensus	Get Census Forecast data for multiple departments. This is an asynchronous service.
POST api/v1/Census/getdashboardcensusactivitylog	Get Dashboard Census Activity Log data . This is an asynchronous service.
GET api/v1/Census/getpartofdaytemplates	Get all Part Of Day Templates. This is an asynchronous service.
POST api/v1/Census/updatecensusformanagecensus	Updates the census and dept forecast values (forecast, actual and staff to) for manage census in actionable dashboard (Asynchronous service). This is an asynchronous service.

Notes

API	Description
GET api/v1/notes?NoteTypeId={NoteTypeId}&FacilityId={FacilityId}&RelationId={RelationId}&RelationIdValue={RelationIdValue}&DepartmentId={DepartmentId}&StartTime={StartTime}&EndTime={EndTime}&NoteCreatedDate={NoteCreatedDate}&ExistsInFS={ExistsInFS}	This method will give you a list of notes related to the specific data passed.
GET api/v1/notes/{noteId}	Get a note by passing the noteId, "primary key". This is an asynchronous service.
PUT api/v1/notes/{noteId}	Update a note providing the noteId. This is an asynchronous service.
POST api/v1/notes	Create a new note it's required to have short noteTypeId, short relationId, string relationIdValue, string tenantId, int costCenterId, the foreign key data can be acquire from get methods in this endpoint. This is an asynchronous service.
DELETE api/v1/notes/{noteId}	Delete a note by noteId. This is an asynchronous service.
GET api/v1/notes/NotesByDepartment?NoteTypeId={NoteTypeId}&FacilityId={FacilityId}&RelationId={RelationId}&RelationIdValue={RelationIdValue}&DepartmentId={DepartmentId}&StartTime={StartTime}&EndTime={EndTime}&NoteCreatedDate={NoteCreatedDate}&ExistsInFS={ExistsInFS}	Get Notes by department
GET api/v1/notes/NotesByEntity?noteTypeId={noteTypeId}&relationId={relationId}&departmentId={departmentId}&tenantId={tenantId}&facilityId={facilityId}&relationIdValue={relationIdValue}	Get Notes by Entity Relation
GET api/v1/notes/NoteTypes	Get a list of note types
GET api/v1/notes/EntityRelations	Get a list of Entity relation
GET api/v1/notes/Tenants	Get a list of Divisions
GET api/v1/notes/Facilities	Get a list of Facilities filter by division
GET api/v1/notes/NotesByAssignment?noteTypeId={noteTypeId}&relationId={relationId}&relationIdValue={relationIdValue}&tenantId={tenantId}&costCenterId={costCenterId}&startDateTime={startDateTime}&endDateTime={endDateTime}	This method will give you a combined list of assignment notes from FS DB and MT DB. This is an asynchronous service.
GET api/v1/notes/CostCentersByFacilityId?tenantId={tenantId}&facilityId={facilityId}	Get the costcenter by tenantId, facilityId

DeptSkillCoverage

API for Department skill Coverage operations.

API	Description
GET api/v1/deptskillcoverage	Return list of all department skill coverages. This is an asynchronous service.
GET api/v1/deptskillcoverage/{deptSkillCoverageId}	Get by id. This is an asynchronous service.
GET api/v1/deptskillcoverage/bydepartment/{departmentId}/{effectiveDate}	Get by department. This is an asynchronous service.
POST api/v1/deptskillcoverage
DELETE api/v1/deptskillcoverage/{deptSkillCoverageId}/{effectiveDate}	Delete a department skill coverage. This is an asynchronous service.

NotificationEventsCallback

Controller for processing notification event callbacks

API	Description
POST api/v1/notificationevents/callback	Callback Endpoint for events triggered by Request-Response SMS Notifications.
POST api/v1/notificationevents/responses	Callback Endpoint for processing Sms responses

Status

API	Description
GET api/v1/status	Returns status information about the service.
GET api/v1/SystemInfo
GET api/v1/UserInfo	Returns user information for the authenticated user.
GET api/v1/profile?Expand={Expand}

StaffPreferences

API for Staff Preferences operations.

API	Description
GET api/v1/staffpreferences/{staffId}	Retrieves the staff's preference for the specified staff Id
POST api/v1/staffpreferences	Save staff preference for the specified staff
POST api/v1/staffpreferences/schedule	Returns the preferences of staff in a given schedule date range

StaffExceptionAndConflictLogs

Crud controller for staffexceptionandconflictlogs

API	Description
GET api/v1/hr/staffexceptionandconflictlogs	Get a list of StaffExceptionAndConflictLogsmodel
GET api/v1/hr/staffexceptionandconflictlogs/{staffExceptionAndConflictLogId}	Get a StaffExceptionAndConflictLogModel by primary key
PUT api/v1/hr/staffexceptionandconflictlogs/{staffExceptionAndConflictLogId}	Update StaffExceptionAndConflictLogModel by primary key
POST api/v1/hr/staffexceptionandconflictlogs	Create a new StaffExceptionAndConflictLogMode
DELETE api/v1/hr/staffexceptionandconflictlogs/{staffExceptionAndConflictLogId}	Delete StaffExceptionAndConflictLogModel by primary key
GET api/v1/hr/staffexceptionandconflictlogs/ByDivision	Get a list of StaffExceptionAndConflictLogs with Division Name

DepartmentsPerClusters

Crud controller for departmentsperclusters

API	Description
GET api/v1/dashboardconfig/departmentsperclusters	Get a list of DepartmentsPerClustersmodel. This is an asynchronous service.
GET api/v1/dashboardconfig/departmentsperclusters/dashboard/{dashboardId}	Get a list of DepartmentsPerClustersmodel. This is an asynchronous service.
GET api/v1/dashboardconfig/departmentsperclusters/{departmentPerClusterId}	Get a DepartmentsPerClusterModel by primary key. This is an asynchronous service.
PUT api/v1/dashboardconfig/departmentsperclusters/{departmentPerClusterId}	Update DepartmentsPerClusterModel by primary key. This is an asynchronous service.
POST api/v1/dashboardconfig/departmentsperclusters	Create a new DepartmentsPerClusterMode. This is an asynchronous service.
DELETE api/v1/dashboardconfig/departmentsperclusters/{departmentPerClusterId}	Delete DepartmentsPerClusterModel by primary key. This is an asynchronous service.

FacilityConfigs

API related to FacilityConfigs

API	Description
POST api/v1/facilityconfigs	Creates a new FacilityConfig
GET api/v1/facilityconfigs/{facilityId}	Returns a FailityConfig for the given Facility ID.
PUT api/v1/facilityconfigs	Updates a FailityConfig
DELETE api/v1/facilityconfigs/{facilityId}	Deletes a FailityConfig for the given Facility ID.

StaffCompetencies

Crud controller for staffcompetencies

API	Description
GET api/v1/staffcompetencies/{staffId}	Get a list of StaffCompetenciesmodel
PUT api/v1/staffcompetencies/{staffId}
POST api/v1/staffcompetencies/getbystaffids

AppSettingConfig

Crud controller for AppSettingConfig

API	Description
GET api/v1/AppSettingConfig/byKey/{configKey}	Get all department shift targets. This is an asynchronous service.

PremiumLabor

API for Need operations.

API	Description
POST api/v1/premiumlabor	Retrieve the Premium Labor Data
POST api/v1/premiumlabor/Save	Save Premium Labor Level Settings and Returns the data.

SurgeAlerts

API	Description
GET api/v1/surgealerts/{tenantId}/{userId}	List SurgeAlerts based on preferences setup by a particular user

UserStaffPreferences

Crud controller for userstaffpreferences

API	Description
GET api/v1/userstaffpreferences	Get a list of UserStaffPreferencesmodel
GET api/v1/userstaffpreferences/{userStaffPreferenceId}	Get a UserStaffPreferenceModel by primary key
POST api/v1/userstaffpreferences	Create a new UserStaffPreferenceMode
DELETE api/v1/userstaffpreferences/{userStaffPreferenceId}	Delete UserStaffPreferenceModel by primary key
GET api/v1/userstaffpreferences/{sourceId}/{dashboardId}/{userId}/{staffId}/preferences/filters	Get filter prefereces for user and staff
GET api/v1/userstaffpreferences/{sourceId}/{userId}/{staffId}/preferences/filters	No documentation available.
GET api/v1/userstaffpreferences/{sourceId}/{dashboardId}/{userId}/{staffId}/preferences/surge	Get Surge preferences for user and staff for Dashboard page
GET api/v1/userstaffpreferences/{sourceId}/{userId}/{staffId}/preferences/surge	Get Surge preferences for user and staff for FS Application
POST api/v1/userstaffpreferences/{sourceId}/{dashboardId}/{userId}/{staffId}/preferences/filters	Adds new Filter preferences
POST api/v1/userstaffpreferences/{sourceId}/{dashboardId}/{userId}/{staffId}/preferences/surge	Add and updates surge preferences for dashboard
POST api/v1/userstaffpreferences/{sourceId}/{userId}/{staffId}/preferences/surge	Add and updates surge preferences for FS appication
PUT api/v1/userstaffpreferences/{sourceId}/{dashboardId}/{userId}/{staffId}/preferences/filters/{filterId}	Updates Filter preferences
DELETE api/v1/userstaffpreferences/{sourceId}/{dashboardId}/{userId}/{staffId}/preferences/filters/{filterId}	Deleted Filter preferences

DepartmentShifts

Department Shift Conroller

API	Description
POST api/v1/DepartmentShifts	Creates a new department shift for the department
POST api/v1/DepartmentShifts/CopyTo/{facilityId}/{departmentId}/{departmentShiftId}	Copies the shift from the depatment to another department or another facility and department
GET api/v1/DepartmentShifts/{departmentId}/{hideRequestable}	Retrieves a list of Shifts for the supplied Department. Include or not include Shifts that the staff can request.
GET api/v1/DepartmentShifts/{departmentIds}	Returns all shifts for the provided department Ids.
GET api/v1/DepartmentShifts/active/{departmentId}	Retrieves a list of active Department Shifts for the provided Department Id. This is an asynchronous service.
GET api/v1/DepartmentShifts/active/{departmentId}/{date}	Retrieves a list of active Department Shifts for the provided Department Id and Date. This is an asynchronous service.
GET api/v1/DepartmentShifts/GetStaffSplits/{departmentId}/{productiveId}/{date}/{startTime}/{endTime}	Gets a list of shifts staff can request by time range. Will include all shifts that fall in the range of the requested time. This is an asynchronous service.
GET api/v1/DepartmentShifts/PtoShifts	Get Requestable Shifts for Department.
PUT api/v1/DepartmentShifts	Creates a new department shift for the department
DELETE api/v1/DepartmentShifts/{departmentShiftId}	Deletes the shift

PatientClassificationRatings

Crud controller for patientclassificationratings

API	Description
GET api/v1/pcsratings	Get a list of FsPatientClassificationRatingsmodel
GET api/v1/pcsratings/{patientClassificationRatingID}	Get a FsPatientClassificationRatingModel by primary key
GET api/v1/pcsratings/GetPatientClassificationRatingWithDetails/{patientClassificationRatingID}	Get a List of PatientClassificationRatingModels including all census and levels.
POST api/v1/pcsratings/CreatePatientClassificationRatingWithDetails	Create a new FsPatientClassificationRatingMode
PUT api/v1/pcsratings/UpdatePatientClassificationRatingWithDetails	Update Average Rating and Total Census.
PUT api/v1/pcsratings/{fsPatientClassificationRatingID}?patientClassificationRatingID={patientClassificationRatingID}	Update FsPatientClassificationRatingModel by primary key

UserNotificationResponses

Crud controller for UserNotificationResponses

API	Description
GET api/v1/usernotificationresponses	Get a list of UserNotificationResponsesmodel
GET api/v1/usernotificationresponses/{userNotificationResponseId}	Get a UserNotificationResponseModel by primary key
PUT api/v1/usernotificationresponses/{userNotificationResponseId}	Update UserNotificationResponseModel by primary key
POST api/v1/usernotificationresponses	Create a new UserNotificationResponseMode
DELETE api/v1/usernotificationresponses/{userNotificationResponseId}	Delete UserNotificationResponseModel by primary key

Events

Allows administrators to manually trigger application events for testing.

API	Description
POST api/v1/admin/events/schedulechanged	Trigger the ScheduleChanged event.

DepartmentSummaryCompetencies

Crud controller for departmentsummarycompetencies

API	Description
GET api/v1/departmentsummarycompetencies	Get a list of DepartmentSummaryCompetenciesmodel
GET api/v1/departmentsummarycompetencies/{departmentSummaryCompetencyId}	Get a DepartmentSummaryCompetencyModel by primary key
PUT api/v1/departmentsummarycompetencies	Update DepartmentSummaryCompetencies associated MinimumCount
POST api/v1/departmentsummarycompetencies/BatchOperations	Batch multiple operations: create,update and delete
POST api/v1/departmentsummarycompetencies	Create new DepartmentSummaryCompetencyModel
DELETE api/v1/departmentsummarycompetencies	Delete DepartmentSummaryCompetency
GET api/v1/departmentsummarycompetencies?departmentId={departmentId}&effectiveDate={effectiveDate}	Get a list of Active DepartmentSummaryCompetencies model given DepartmentId and effectiveDate
PUT api/v1/departmentsummarycompetencies/replacedepartmentsummaries	Replace DepartmentSummary associated with DepartmentSummaryCompetency

PlusMetrics

Proxy to Plus Isas Api Server

API	Description
GET api/v1/PlusMetrics?departmentId={departmentId}&startDate={startDate}&currentTimeStamp={currentTimeStamp}	Get PlusMetrics by department id, date and current timestamp to calculate pay periods and month dates
GET api/v1/PlusMetrics/ByIsasIds/{coId}/{deptOrGroupNumber}?fromDate={fromDate}&toDate={toDate}	Get PlusMetrics by Isas department AdmNumber and facility Coid

DepartmentSkills

API for Department Skills operations.

API	Description
GET api/v1/departmentskills/CanEdit/{departmentId}/{effectiveDate}	Returns a boolean indicating if the requesting user has permissions to edit a department skill. This is an asynchronous service.
GET api/v1/departmentskills/CanView	Returns a boolean indicating if the requesting user has permissions to view department skills.
POST api/v1/departmentskills/{departmentId}/{skillLevelId}/{licensed}/{effectiveDate}/{includeInISASStaffingGrid}	Create a new department skill. This is an asynchronous service.
POST api/v1/departmentskills/{departmentId}/{skillLevelId}/{licensed}/{effectiveDate}	Create a new department skill. This is an asynchronous service.
GET api/v1/departmentskills/{departmentId}/{effectiveDate}	Get list of department skills for department.
POST api/v1/departmentskills/ByDepartments	Get list of active department skills for list of departments
GET api/v1/departmentskills/{departmentId}/{effectiveDate}/{staffId}	Get list of department skills for staff member.
DELETE api/v1/departmentskills/{departmentSkillId}/{effectiveDate}	Delete department skill. This is an asynchronous service.
PUT api/v1/departmentskills/{departmentSkillId}/{licensed}/{effectiveDate}	Update department skill. This is an asynchronous service.
PUT api/v1/departmentskills/{departmentSkillId}/{licensed}/{effectiveDate}/{includeInISASStaffingGrid}	Update department skill. This is an asynchronous service.

StaffingExceptionsSkills

Crud controller for staffingexceptionsskills

API	Description
GET api/v1/staffingexceptionsskills	Get a list of StaffingExceptionsSkillsmodel
GET api/v1/staffingexceptionsskills/{staffingExceptionsSkillId}	Get a StaffingExceptionsSkillModel by primary key
PUT api/v1/staffingexceptionsskills/{staffingExceptionsSkillId}	Update StaffingExceptionsSkillModel by primary key
POST api/v1/staffingexceptionsskills	Create a new StaffingExceptionsSkillMode
DELETE api/v1/staffingexceptionsskills/{staffingExceptionsSkillId}	Delete StaffingExceptionsSkillModel by primary key

SchedulePlans

Schedule Plans Controller

API	Description
POST api/v1/scheduleplans	Gets the Schedule Non Compliance Results..

UserNotificationHeaders

Crud controller for UserNotificationHeader

API	Description
GET api/v1/usernotificationheader	Get a list of UserNotificationHeadersmodel
GET api/v1/usernotificationheader/{userNotificationId}	Get a UserNotificationHeaderModel by primary key
PUT api/v1/usernotificationheader/{userNotificationId}	Update UserNotificationHeaderModel by primary key
POST api/v1/usernotificationheader	Create a new UserNotificationHeaderMode
DELETE api/v1/usernotificationheader/{userNotificationId}	Delete UserNotificationHeaderModel by primary key
GET api/v1/usernotificationheader/{userId}/{staffId}/{startDate}	Retrieves the usernotification by date and user id
POST api/v1/usernotificationheader/{userId}/{staffId}/{notificationId}/{responseId}	update user response for notification

Assignments

API for Assignment operations.

API	Description
GET api/v1/assignments/{assignmentId}	Get assignment by ID.
POST api/v1/assignments	Create a new assignment.
PUT api/v1/assignments	Update an assignment.
DELETE api/v1/assignments/{assignmentId}	Delete an assignment
DELETE api/v1/assignments/{assignmentId}/plansheet	For self scheduling. Delete Plan Sheet Phase Assignment.
POST api/v1/assignments/{assignmentId}/cancel	Cancel an assignment.
POST api/v1/assignments/{assignmentId}/split	Split an assignment into two assignments
PATCH api/v1/assignments/{id}/{charge}	Set the charge flag of an assignment.
GET api/v1/assignments?StartDateTime={StartDateTime}&EndDateTime={EndDateTime}&DepartmentId={DepartmentId}&ShowAll={ShowAll}&IsUtc={IsUtc}	Get assignments by the requested criteria
GET api/v1/assignments/staff?StartDateTime={StartDateTime}&EndDateTime={EndDateTime}&DepartmentId={DepartmentId}&ShowAll={ShowAll}&IsUtc={IsUtc}	Returns a list of staff with assignments by the requested criteria.
GET api/v1/assignments/FindByDeptShift/{startDate}/{endDate}/{fsDptShiftIDs}	Get assignments by department shifts. This is an asynchronous service.
GET api/v1/assignments/FindByStaffId/{startDate}/{endDate}/{fsStaffId}	Get list of assignments by staff shifts. This is an asynchronous service.
POST api/v1/assignments/FindByDeptCancelReason	Get canceled assingments for department by cancel reason.
POST api/v1/assignments/FindByStaffCancelReason	Get canceled assingments for staff member by cancel reason.
GET api/v1/assignments/FindByFloatFromDept/{statTime}/{endTime}/{fsDeptId}	Get assignments by department floated from. This is an asynchronous service.
GET api/v1/assignments/FindByEmployeeFloated/{statTime}/{endTime}/{fsStaffId}	Gets assignments for staff member that was floated. This is an asynchronous service.
GET api/v1/assignments/FindByEmployeUnscheduledAbsence/{statTime}/{endTime}/{fsStaffId}	Gets assignments for staff member with unscheduled absence. This is an asynchronous service.
PUT api/v1/assignments/FindSubstituteSplitsShifts	Returns a list of deparment replacement shifts for split assignments
GET api/v1/assignments/bydepartment/{departmentId}/{startDateTime}/{endDateTime}/{isOvertime}	Get Assignments by department. This is an asynchronous service.
GET api/v1/assignments/bydepartmentincludefloatedassignments/{departmentId}/{startDateTime}/{endDateTime}/{isOvertime}/{includeFloatedAssignments}/{includeCompetencies}	Get Assignments by department. This is an asynchronous service.
GET api/v1/assignments/bycluster/{clusterIds}/{startDateTime}/{endDateTime}	Get Assignments by cluster. This is an asynchronous service.
GET api/v1/assignments/bydepartmentskill/{departmentId}/{startDateTime}/{endDateTime}/{isOvertime}/{skillLevelId}	Get Assignments by department and skilllevelId. This is an asynchronous service.
GET api/v1/assignments/byclusterskill/{clusterIds}/{startDateTime}/{endDateTime}/{skillLevelId}	Get Assignments by cluster and skillLevelId. This is an asynchronous service.
GET api/v1/assignments/bydashboard/{dashboardId}/{facilityId}/{clusterId}/{startDateTime}/{endDateTime}/{skillLevelId}	Get Assignments by dashboard by facility. This is an asynchronous service.
POST api/v1/assignments/stafffloat	Get All Staff Floats by Deparments,skillLevelId with in a specified from and toDates This is an asynchronous service.
POST api/v1/assignments/staffcancel	Get All Staff Cancels by Deparments,skillLevelId with in a specified from and toDates This is an asynchronous service.
GET api/v1/assignments/shifts/{deptId}	Returns all shifts for the department
GET api/v1/assignments/productiveids	Returns all shifts for the department. This is an asynchronous service.
GET api/v1/assignments/GetTradeReleaseAssignments/{staffId}/{startDateTime}/{endDateTime}	Get all assignments for trade This is an asynchronous service.
PUT api/v1/assignments/UpdateTradeAssignment	Release or Cancel trade assignments -To Make and cancel availability for trade This is an asynchronous service.
POST api/v1/assignments/RequestTradeAssignments	Get Open Requests and available asignments to trade for staff This is an asynchronous service.
PUT api/v1/assignments/UpdateRequestTradeAssignment/{staffId}/{assignmentId}/{requestTradeType}	Modify request for trade assignments-To Request and cancel trade for assignment This is an asynchronous service.

ContractLaborTransactionTypes

Crud controller for contractlabortransactiontypes

API	Description
GET api/contractlabortransactiontypes	Get a list of ContractLaborTransactionTypesmodel
GET api/contractlabortransactiontypes/{transactionTypeId}	Get a ContractLaborTransactionTypeModel by primary key
PUT api/contractlabortransactiontypes/{transactionTypeId}	Update ContractLaborTransactionTypeModel by primary key
POST api/contractlabortransactiontypes	Create a new ContractLaborTransactionTypeMode
DELETE api/contractlabortransactiontypes/{transactionTypeId}	Delete ContractLaborTransactionTypeModel by primary key

Notifications

Notifications Controller

API	Description
GET api/v1/notifications/templates/{transportMediaId}?eventIds={eventIds}	Get all Notification Templates by NotificationEventId.
GET api/v1/notifications/templates	Get all Notification Templates.
POST api/v1/notifications/requestresponse	Send Request Response Notification to a list of Staff
POST api/v1/notifications/oneway	Send one way Notification to a list of Staff
POST api/v1/notifications/getresponses	Get Notification responses
PUT api/v1/notifications/action	Update NotificationAction
POST api/v1/notifications/sent	Get Notified StaffIds filtered by search criteria
POST api/v1/notifications/template/requestresponse	Send Request Response Notification to a list of Staff
POST api/v1/notifications/template/oneway	Send one way Notification to a list of Staff
POST api/v1/notifications/getactivity	Get Notifications activity

ShiftTargets

API for department shift targets.

API	Description
POST api/v1/shifttargets	Creates/updates a department shift target This is an asynchronous service.
POST api/v1/shifttargets/SaveAllShiftTargets	No documentation available.
GET api/v1/shifttargets/copyshifttargets/{departmentId}/{fromEffectiveDate}/{toEffectiveDate}	Copy Shift Targets from a Dept Schedule Period to another Dept Schedule Period.
GET api/v1/shifttargets/effectivedateranges/{departmentId}	Get Effective Date Ranges for Shift Targets for a Department.
POST api/v1/shifttargets/copyshifttargets	Copy Shift Targets for Dept, Effective Date, Day of Week, Volume Range to Days of Week with Volume Ranges.
GET api/v1/shifttargets/{departmentId}/{effectiveDate}/{dayOfWeekId}	Get all department shift targets. This is an asynchronous service.
GET api/v1/shifttargets/{departmentId}/{effectiveDate}/{dayOfWeekId}/getvolumelevel	get Volume Level, Volume Low and Volume Peak from ShiftTarget
GET api/v1/shifttargets/{departmentId}/{effectiveDate}/getvolumelevels	Get Volume Levels for all 7 Days out of the Week for the Dept and Effective Date.
DELETE api/v1/shifttargets/{departmentId}/{shiftId}/{effectiveDate}/{dayOfWeekId}	Delete department shift targets. This is an asynchronous service.
DELETE api/v1/shifttargets/{departmentId}/{shiftId}/{effectiveDate}/{dayOfWeekId}/{volumeMin}/{volumePeak}	Delete department shift targets. This is an asynchronous service.
GET api/v1/shifttargets/ClearCopiedShiftTargets/{departmentId}	No documentation available.
GET api/v1/shifttargets/UndoCopiedShiftTargets/{departmentId}	No documentation available.