public interface WFMCalendarService750Soap
extends java.rmi.Remote
| Modifier and Type | Method and Description |
|---|---|
void |
acknowledgeNotification(int siteID,
int itemType,
long timestamp)
Acknowledges to the server that notification was received and processed.
|
java.lang.String |
asyncDeleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Request to delete existing Calendar items.
|
java.lang.String |
asyncEditSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Request to update Calendar items.
|
java.lang.String |
asyncGetTimeOffLimits(int siteID,
int target,
int targetID,
int[] types,
double start,
double end,
int granularity)
Requests retrieval of Time Off limit values for specified target and date range.
|
CalLimitInformation[] |
asyncGetTimeOffLimitsRequestInformation(java.lang.String asyncRequestID)
Gets result of previous Time Off limit request.
|
java.lang.String |
asyncInsertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
int siteID,
int[] teams,
int[] agents,
double[] dates,
CalItemShortInformation newItem)
Request insert of the same Calendar item for specified agents and dates to Calendar snapshot.
|
java.lang.String |
asyncInsertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Request insert of the same Calendar item for specified agents and dates to Calendar snapshot.
|
java.lang.String |
asyncSetTimeOffLimits(CalLimitInformation[] information)
Requests update of Time Off limits.
|
CalDateTimeOffBalanceInformation[] |
calculateTimeOffBalanceToDate(int accessLevel,
int siteID,
int[] teams,
int[] agents,
double date,
int[] timeOffTypes)
Calculates Time Off balance hours for the selected target for given date.
|
CalDateTimeOffBalanceInformation[] |
calculateTimeOffCarryOverInformation(int accessLevel,
int siteID,
int[] teams,
int[] agents,
double date,
int[] timeOffs)
Calculates Time Off carry-over date and carry-over hours for the specified target for given date (current date).
|
void |
deleteAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
int[] patternIds)
Deletes specified Agent Availability Patterns.
|
CalItemError[] |
deleteCalendarItems(int accessLevel,
int siteID,
CalItemShortInformation[] items)
Deletes existing calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
deleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Delete specified Calendar items from snapshot.
|
CalItemError[] |
editCalendarItems(int accessLevel,
int siteID,
CalItemShortInformation[] items)
Edits existing Calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
editSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Updates specified Calendar items in snapshot.
|
int |
findAgentInSnapshot(java.lang.String snapshotID,
int field,
java.lang.String value,
int startIndex)
Find first index of matching agent in Calendar snapshot.
|
void |
generateAgentAvailabilityItems(int accessLevel,
int siteId,
int agentId,
int patternId,
double start,
int numberOfDays,
int status)
Generates Availability items from specified pattern starting from requested date.
|
CalAgentPatterns[] |
getAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId)
Gets Availability Patterns configured for specified Agent.
|
CalDateShift[] |
getAllShiftByAgentAndDateEx(int siteID,
int[] teamIDArray,
int[] agentIDArray,
double[] dateArray,
int sortMode,
boolean sortAscending)
Returns all configured shifts for specified agents.
|
CalData |
getAsyncCalendarItemsData(java.lang.String asyncRequestID)
Gets result of previous asynchronous request for Calendar data.
|
CalUpdatedSnapshot |
getAsyncCalendarSnapshotUpdate(java.lang.String asyncRequestID)
Gets result of previous asynchronous request for Calendar snapshot update.
|
CalData |
getCalendarItemsFromSnapshot(java.lang.String snapshotId,
int startItem,
int endItem,
int request)
Retrieve Calendar items from snapshot from index startItem to index endItem.
|
CalSnapshot |
getCalendarSnapshotResult(java.lang.String requestID)
Gets result of previous asynchronous request for Calendar snapshot.
|
ShiftHolder |
getShiftByAgentAndDateEx(int siteID,
int[] teamIDArray,
int[] agentIDArray,
double[] dateArray,
int sortMode,
boolean sortAscending)
Returns only shifts available for all specified agents.
|
CalTimeOffConfiguration[] |
getTimeOffConfiguration(int accessLevel,
int siteID,
int[] teams,
int[] agents,
int[] timeOffIDs)
Returns Time Off rule configuration for specified Time Off types and agents.
|
CalTimeOffInformation[] |
getTimeOffInformation(int accessLevel,
int siteID,
int[] teams,
int[] agents,
double date,
int[] timeOffTypes)
Calculates and returns values of Agent Time Off balance information.
|
CalItemError[] |
insertCalendarItems(int accessLevel,
int siteID,
CalItemShortInformation[] items)
Inserts new Calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
insertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
int siteID,
int[] teams,
int[] agents,
double[] dates,
CalItemShortInformation newItem)
Insert the same Calendar item for specified agents and dates to Calendar snapshot.
|
CalUpdatedSnapshot |
insertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
Insert new Calendar items for specified agents and dates to Calendar snapshot.
|
CalSnapshot |
openCalendarSnapshotForDates(int accessLevel,
int[] sites,
int[] teams,
int[] agents,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
Opens sorted and filtered snapshot of Calendar items for the specified agents and dates
|
java.lang.String |
openCalendarSnapshotForDatesAsync(int accessLevel,
int[] sites,
int[] teams,
int[] agents,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
Request to open sorted and filtered snapshot of Calendar items for the specified agents and dates
|
CalNotification |
pollNotification(long timestamp,
int siteID,
int itemType,
int[] teamIDArray,
int[] agentIDArray,
double calStartDate,
double calEndDate,
int detailsLevel,
boolean provideAgentInfo)
Polls calendar data change notifications
|
CalData |
queryCalendarItemsForDates(int accessLevel,
int[] sites,
int[] teams,
int[] agents,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
Returns sorted and filtered array of Calendar items for the specified agents and dates.
|
java.lang.String |
queryCalendarItemsForDatesAsync(int accessLevel,
int[] sites,
int[] teams,
int[] agents,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
Requests sorted and filtered array of Calendar items for the specified agents and dates.
|
void |
setAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
CalAgentPatterns[] patterns)
Modifies (creates new, updates existing) Agent Availability Patterns.
|
void |
updateCalendarSnapshot(java.lang.String snapshotId,
CalSort sort)
Updates existing Calendar snapshot (used to change sort order)
|
ShiftHolder getShiftByAgentAndDateEx(int siteID, int[] teamIDArray, int[] agentIDArray, double[] dateArray, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID - Site IDteamIDArray - Team ID arrayagentIDArray - Agent ID arraydateArray - Requested datessortMode - Sort criteriasortAscending - Ascending/Descendingjava.rmi.RemoteExceptionCalDateShift[] getAllShiftByAgentAndDateEx(int siteID, int[] teamIDArray, int[] agentIDArray, double[] dateArray, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID - Site IDteamIDArray - Team ID arrayagentIDArray - Agent ID arraydateArray - Requested datessortMode - Sort criteriasortAscending - Ascending/Descendingjava.rmi.RemoteExceptionCalSnapshot getCalendarSnapshotResult(java.lang.String requestID) throws java.rmi.RemoteException
requestID - Async request IDjava.rmi.RemoteExceptionCalData getAsyncCalendarItemsData(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID - Async request IDjava.rmi.RemoteExceptionCalUpdatedSnapshot getAsyncCalendarSnapshotUpdate(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID - Async request IDjava.rmi.RemoteExceptionjava.lang.String asyncInsertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
int siteID,
int[] teams,
int[] agents,
double[] dates,
CalItemShortInformation newItem)
throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDteams - Team ID arrayagents - Agent ID arraydates - Requested datesnewItem - New Calendar item (agent and date information ignored and taken from agents and dates parameters)java.rmi.RemoteExceptionECalAccessLevelsCalUpdatedSnapshot insertSnapshotCalendarItem(java.lang.String snapshotID, int accessLevel, int siteID, int[] teams, int[] agents, double[] dates, CalItemShortInformation newItem) throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDteams - Team ID arrayagents - Agent ID arraydates - Requested datesnewItem - New Calendar item (agent and date information ignored and taken from agents and dates parameters)java.rmi.RemoteExceptionECalAccessLevelsCalItemError[] insertCalendarItems(int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
accessLevel - User access levelsiteID - Site IDitems - Array of item information. Agent and date information is provided here.java.rmi.RemoteExceptionECalAccessLevelsjava.lang.String asyncInsertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDitems - Array of item information. Agents and dates information are provided here.java.rmi.RemoteExceptionECalAccessLevelsCalUpdatedSnapshot insertSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDitems - Array of item information. Agents and dates information are provided here.java.rmi.RemoteExceptionECalAccessLevelsCalItemError[] editCalendarItems(int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
accessLevel - User access levelsiteID - Site IDitems - Array of item information. Agents and dates information are provided here. In order to modify Exception or Time Off items, you need to set the itemID.java.rmi.RemoteExceptionECalAccessLevelsjava.lang.String asyncEditSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDitems - Array of item information. Agent and date information is provided here. In order to modify Exception or Time Off items, you may need to set the itemID.java.rmi.RemoteExceptionCalUpdatedSnapshot editSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDitems - Array of item information. Agent and date information is provided here. In order to modify Exception or Time Off items, you may need to set the itemID.java.rmi.RemoteExceptionCalItemError[] deleteCalendarItems(int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
accessLevel - User access levelsiteID - Site IDitems - Array of item information. Agent and date information is provided here. In order to modify Exception or Time Off items, you may need to set the itemID.java.rmi.RemoteExceptionECalAccessLevelsjava.lang.String asyncDeleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
CalItemShortInformation[] items)
throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDitems - Array of item information. Agent and date information is provided here. In order to modify Exception or Time Off items, you may need to set the itemID.java.rmi.RemoteExceptionCalUpdatedSnapshot deleteSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, CalItemShortInformation[] items) throws java.rmi.RemoteException
snapshotID - Snapshot IDaccessLevel - Agent/SupervisorsiteID - Site IDitems - Array of item information. Agent and date information is provided here. In order to modify Exception or Time Off items, you may need to set the itemID.java.rmi.RemoteExceptionCalData queryCalendarItemsForDates(int accessLevel, int[] sites, int[] teams, int[] agents, double[] dates, int schScenarioID, CalFilter filter, CalSort sort, int request) throws java.rmi.RemoteException
accessLevel - User access levelsites - Array of Site IDs (only 1 Site supported in version 7.x), at least one site should always be present (related to teams and agents)teams - Array of Team IDs. Only teams from the same Site are supported. The value here works as a filter to include agents with specified team identifiers. A value of Null here returns all applicable agents, regardless of their team assignment.agents - Array of Agent IDsdates - Date arrayschScenarioID - Schedule scenario ID, 0 - Master (required for actual status resolution)filter - Filter optionssort - Sort parametersrequest - Request flag to indicate required information.java.rmi.RemoteExceptionECalAccessLevelsjava.lang.String queryCalendarItemsForDatesAsync(int accessLevel,
int[] sites,
int[] teams,
int[] agents,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
throws java.rmi.RemoteException
accessLevel - User access levelsites - Array of Site IDs (only 1 Site supported in version 7.x), at least one site should always be present (related to teams and agents)teams - Array of Team IDs. Only teams from the same Site are supported. The value here works as a filter to include agents with specified team identifiers. A value of Null here returns all applicable agents, regardless of their team assignment.agents - Array of Agent IDsdates - Date arrayschScenarioID - Schedule scenario ID, 0 - Master (required for actual status resolution)filter - Filter optionssort - Sort parametersrequest - Request flag to indicate required information.java.rmi.RemoteExceptionECalAccessLevelsCalSnapshot openCalendarSnapshotForDates(int accessLevel, int[] sites, int[] teams, int[] agents, double[] dates, int schScenarioID, CalFilter filter, CalSort sort) throws java.rmi.RemoteException
accessLevel - User access levelsites - Array of Site IDs (only 1 Site supported in version 7.x), at least one site should always be present (related to teams and agents)teams - Array of Team IDs. Only teams from the same Site are supported. The value here works as a filter to include agents with specified team identifiers. A value of Null here returns all applicable agents, regardless of their team assignment.agents - Array of Agent IDsdates - Date arrayschScenarioID - Schedule scenario ID, 0 - Master (required for actual status resolution)filter - Filter optionssort - Sort parametersjava.rmi.RemoteExceptionECalAccessLevelsjava.lang.String openCalendarSnapshotForDatesAsync(int accessLevel,
int[] sites,
int[] teams,
int[] agents,
double[] dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
throws java.rmi.RemoteException
accessLevel - User access levelsites - Array of Site IDs (only 1 Site supported in version 7.x), at least one site should always be present (related to teams and agents)teams - Array of Team IDs. Only teams from the same Site are supported. The value here works as a filter to include agents with specified team identifiers. A value of Null here returns all applicable agents, regardless of their team assignment.agents - Array of Agent IDsdates - Date arrayschScenarioID - Schedule scenario ID, 0 - Master (required for actual status resolution)filter - Filter optionssort - Sort parametersjava.rmi.RemoteExceptionECalAccessLevelsvoid updateCalendarSnapshot(java.lang.String snapshotId,
CalSort sort)
throws java.rmi.RemoteException
snapshotId - Snapshot IDsort - Sort criteriajava.rmi.RemoteExceptionint findAgentInSnapshot(java.lang.String snapshotID,
int field,
java.lang.String value,
int startIndex)
throws java.rmi.RemoteException
snapshotID - Snapshot IDfield - Agent properties indicator (ECfgAgentField)value - Property valuestartIndex - Search start indexjava.rmi.RemoteExceptionECfgAgentFieldCalData getCalendarItemsFromSnapshot(java.lang.String snapshotId, int startItem, int endItem, int request) throws java.rmi.RemoteException
snapshotId - Snapshot IDstartItem - Start indexendItem - End indexrequest - Request flag to indicate required information.java.rmi.RemoteExceptionCalTimeOffConfiguration[] getTimeOffConfiguration(int accessLevel, int siteID, int[] teams, int[] agents, int[] timeOffIDs) throws java.rmi.RemoteException
accessLevel - User access levelsiteID - Site IDteams - Team ID(s)agents - Agent ID(s)timeOffIDs - Time Off type ID(s)java.rmi.RemoteExceptionCalDateTimeOffBalanceInformation[] calculateTimeOffBalanceToDate(int accessLevel, int siteID, int[] teams, int[] agents, double date, int[] timeOffTypes) throws java.rmi.RemoteException
accessLevel - User access levelsiteID - Site IDteams - Team ID(s)agents - Agent ID(s)date - Requested datetimeOffTypes - Time Off types array - filter, empty = all typesjava.rmi.RemoteExceptionECalAccessLevelsCalTimeOffInformation[] getTimeOffInformation(int accessLevel, int siteID, int[] teams, int[] agents, double date, int[] timeOffTypes) throws java.rmi.RemoteException
accessLevel - - User access levelsiteID - Site IDteams - Team ID(s)agents - Agent ID(s)timeOffTypes - Time Off types array - filter, empty = all typesjava.rmi.RemoteExceptionECalAccessLevelsCalDateTimeOffBalanceInformation[] calculateTimeOffCarryOverInformation(int accessLevel, int siteID, int[] teams, int[] agents, double date, int[] timeOffs) throws java.rmi.RemoteException
accessLevel - User access levelsiteID - Site IDteams - Team ID(s)agents - Agent ID(s)timeOffs - Time Off types array - filter, empty = all typesjava.rmi.RemoteExceptionECalAccessLevelsCalAgentPatterns[] getAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId) throws java.rmi.RemoteException
accessLevel - User access levelsiteId - Site IDagentId - Agent IDjava.rmi.RemoteExceptionvoid setAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
CalAgentPatterns[] patterns)
throws java.rmi.RemoteException
accessLevel - User access levelsiteId - Site IDagentId - Agent IDpatterns - New/Updated Agent Availability Paternsjava.rmi.RemoteExceptionvoid deleteAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
int[] patternIds)
throws java.rmi.RemoteException
accessLevel - User access levelsiteId - Site IDagentId - Agent IDpatternIds - Pattern ID(s)java.rmi.RemoteExceptionvoid generateAgentAvailabilityItems(int accessLevel,
int siteId,
int agentId,
int patternId,
double start,
int numberOfDays,
int status)
throws java.rmi.RemoteException
accessLevel - User access levelsiteId - Site IDagentId - Agent IDpatternId - Pattern IDstart - Start DatenumberOfDays - Number of daysstatus - Initial generated Availability statusjava.rmi.RemoteExceptionjava.lang.String asyncGetTimeOffLimits(int siteID,
int target,
int targetID,
int[] types,
double start,
double end,
int granularity)
throws java.rmi.RemoteException
siteID - Site IDtarget - Target level (ECalLimitTarget)targetID - Target IDtypes - Limit types (ECalLimitType)start - Start Dateend - Start Dategranularity - Daily/Timestepjava.rmi.RemoteExceptionECalLimitTarget,
ECalLimitTypejava.lang.String asyncSetTimeOffLimits(CalLimitInformation[] information) throws java.rmi.RemoteException
information - Limit informationjava.rmi.RemoteExceptionCalLimitInformation[] asyncGetTimeOffLimitsRequestInformation(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID - Async request IDjava.rmi.RemoteExceptionCalNotification pollNotification(long timestamp, int siteID, int itemType, int[] teamIDArray, int[] agentIDArray, double calStartDate, double calEndDate, int detailsLevel, boolean provideAgentInfo) throws java.rmi.RemoteException
timestamp - A timestamp value to use as a baseline for notifications. A timestamp value to use as a baseline for notifications. A zero value implies current moment and negative value tells server to use last acknowledged timestamp as a baseline.siteID - Site ID. A negative ID can be used to track changes for all sites.itemType - A calendar item type ECalItems to track changes for. Use CAL_ITEM_UNKNOWN type value to request notification for all item types.teamIDArray - Team ID filter. Can be "null" meaning "any team"agentIDArray - Agent ID filter. Can be null meaning "all agents for specified teams". If teams were not specified - means "all agents".calStartDate - Start date of calendar data range that needs to be tracked for changes. OleDateTimecalEndDate - End date of calendar data range that needs to be tracked for changes. OleDateTimedetailsLevel - Notification details level ECalAuditLevelprovideAgentInfo - ells whether to provide short agent information about every unique agent in response.CalNotificationjava.rmi.RemoteExceptionvoid acknowledgeNotification(int siteID,
int itemType,
long timestamp)
throws java.rmi.RemoteException
pollNotification(long, int, int, int[], int[], double, double, int, boolean).siteID - Site IDitemType - timestamp - A timestamp value from CalNotification returned by pollNotification(long, int, int, int[], int[], double, double, int, boolean)java.rmi.RemoteExceptionCopyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.