Provides methods to manage resources and resource notes, delegate work between resources, and get working dates/times for a resource. More...

Public Member Functions
ResourceIdentity	AddCaseParticipant (string sessionId, WorkerResource resource)
	This function is deprecated. Please use AddCaseParticipant3 instead Adds a new resource based on the resource supplied. More...

ResourceIdentity	AddCaseParticipant2 (string sessionId, CaseParticipant caseParticipant)
	This function is deprecated. Please use AddCaseParticipant4 instead Adds a new resource based on the given participant's details More...

void	AddCaseParticipant3 (string sessionId, CaseParticipant2 resource)
	This function is deprecated. Please use AddCaseParticipant4 instead Adds a new resource based on the given participant's details More...

ResourceIdentity	AddCaseParticipant4 (string sessionId, CaseParticipant2 resource)
	Adds a new resource based on the given participant's details More...

void	AddExternalWorkerGroupResource (string sessionId, WorkerGroupResource groupResource)
	This method is deprecated. Please use AddCaseParticipant3 instead More...

string	AddNote (string sessionId, ResourceIdentity ownerId, string subject, string noteText)
	Adds a note to the specified resource. More...

ResourceIdentity	AddWorkerGroupResource (string sessionId, WorkerGroupResource resource)
	Adds a new group resource based on the information provided. More...

void	AddWorkerGroupResourceMember (string sessionId, ResourceIdentity groupResource, ResourceIdentity memberResource)
	Adds an existing resource to the specified group More...

ResourceIdentity	AddWorkerResource (string sessionId, WorkerResource resource)
	This function is deprecated. Please use AddWorkerResource2 instead. Adds a resource with the specified details. More...

void	AddWorkerResource2 (string sessionId, WorkerResource2 resource)
	Please note that this function is deprecated. Please use AddWorkerResource3 instead. Adds a resource using the specified details. More...

ResourceIdentity	AddWorkerResource3 (string sessionId, WorkerResource2 resource)
	Adds a resource using the specified details. More...

ResourceIdentity	AddWorkerResource4 (string sessionId, WorkerResource2 resource, ResourceIdentityCollection addToGroups)
	Adds a resource using the specified details. Also can specify groups that the resource should be added to using the addToGroups parameter More...

DateTime	ApplySkillLevelToResourceAndProcess (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processId, SkillLevel skillLevel, string comments, bool overwrite)
	Assigns a skill level for a specified process to a specified resource More...

void	AssignWorkAllocationRuleToGroup (string sessionId, ResourceIdentity groupIdentity, WorkAllocationRuleIdentity ruleIdentity)
	Associates a work allocation rule to a group. More...

void	DelegateFromTo (string sessionId, ResourceIdentity delegator, ResourceIdentity delegatee, DelegationOptions options)
	Allows work to be delegated from one resource to another until a given date or indefinitely. More...

void	DeleteResource (string sessionId, ResourceIdentity resourceIdentity, bool checkMaps, bool overrideSupervisorCheck)
	Deletes the specified resource. More...

bool	DoesResourceExist (string sessionId, ResourceIdentity resourceIdentity)
	Determines whether the specified resource exists. More...

bool	DoesResourceHaveADelegatee (string sessionId, ResourceIdentity delegator)
	Checks whether the specified resource is delegating thier activities to another resource. More...

bool	DoesResourceHaveDelegators (string sessionId, ResourceIdentity delegatee)
	Checks whether the specified resource is assigned as a delagtee for any other resources. More...

void	ExcludeFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity)
	Set ths resource as unavailable when doing Manual Work Allocation from the TotalAgility Workspace. More...

ResourceSummaryCollection	GetAssociatedGroups (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the groups associated with the specified resource. More...

ProcessIdentityCollection	GetAssociatedProcesses (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the associated processes for the specified resource More...

AvailableResources	GetAvailableResourcesWithSkillLevelForActivities (string sessionId, ProcessActivityIdentityCollection activities, DateTime startDate, DateTime endDate)
	This method is deprecated. Please use GetAvailableResourcesWithSkillLevelForActivities2 instead. Retrieves the available resources with a sufficient skill level to perform the specified activities. More...

AvailableResources	GetAvailableResourcesWithSkillLevelForActivities2 (string sessionId, JobActivityIdentityCollection activities, DateTime startDate, DateTime endDate)
	Retrieves the available resources with a sufficient skill level to perform the specified activities More...

ResourceAvailabilityCollection	GetAvailableResourcesWithSkillLevelForProcess (string sessionId, ResourceIdentity onLoanGroupResourceIdentity, ProcessIdentity processIdentity, short skillLevel, DateTime startDate, DateTime endDate)
	Retrieves a list of resources with the minimum skill level required for a specified process. More...

CaseParticipant2	GetCaseParticipant (string sessionId, ResourceIdentity resource)
	Gets a resource associated with a case based on the given participant's details. More...

CategoryIdentity	GetCategoryForResource (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the Id and Name of the category assigned to a specified resource More...

Model.Resources.Delegate	GetDelegation (string sessionId, ResourceIdentity delegatorResource)
	Retrieves the delegation for a specified resource. More...

DelegateInfoCollection	GetDelegations (string sessionId)
	Retrieves a list of all delegations. More...

LdapResourceCollection	GetFailedToSynchLdapResourcesFromXml (string sessionId, string errorsXml)
	Gets a list of the LDAP resources that failed to synchronize from the error output in XML. More...

DateTime	GetFutureDateUsingWorkingDaysForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days)
	Get a date in the future using a specified number of working days from a date. More...

DateTime	GetFutureDateUsingWorkingHoursForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int hours)
	Get a date in the future using a specified number of working hours from a date. More...

DateTime	GetFutureDateUsingWorkingMinutesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int minutes)
	Get a date in the future using a specified number of working minutes from a date. More...

DateTime	GetFutureDateUsingWorkingSecondsForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int seconds)
	Get a date in the future using a specified number of working seconds from a date. More...

DateTime	GetFutureDateUsingWorkingTimeForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days, int hours, int minutes, int seconds)
	Get a date in the future by adding a specified working time to a date. More...

ResourceSummaryCollection	GetGroupResourceMembers (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the groups and workers associated with the specified resource. More...

int	GetLoanedSecondsForResourceBetweenDates (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroupIdentity)
	Gets the number of seconds a resource has been on loan to a group. More...

TimePeriod	GetLoanedTimeForResourceBetweenDates (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroupIdentity)
	Calculates the amount of time the specified resource is allocated as on loan to the specified group between the dates given. More...

NetTimeForResource	GetLoanedTimeForResourcesBetweenDates (string sessionId, ResourceIdentity resourceIdentity, int workloadInSeconds, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroup)
	Works out a resource's total and net remaining working days on loan to a specified resource, taking into account a specifiable existing workload. More...

ResourceSummaryCollection	GetMembersOfGroup (string sessionId, ResourceIdentity groupResourceId, bool useManualWorkAllocationExclusion)
	Retrieves the resources that are members of the specified group. More...

NetTimeForResource	GetNetTimeBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, int workloadInSeconds, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroupIdentity)
	Works out the amount of time a resource will be available between the dates specified, taking into account a specifiable existing work load. More...

NoteCollection	GetNotes (string sessionId, ResourceIdentity ownerId, NoteFilter noteFilter)
	Retrieves the notes for the specified resource using specified note filter. More...

long	GetNumberOfActivitiesAssignedToResource (string sessionId, ResourceActivityFilter resourceActivityFilter)
	Gets the number of activities assigned to the specified resource. More...

DateTime	GetPastDateUsingWorkingDaysForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days)
	Get a date in the past using a specified number of working days from a date. More...

DateTime	GetPastDateUsingWorkingHoursForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int hours)
	Get a date in the past using a specified number of working hours from a date. More...

DateTime	GetPastDateUsingWorkingMinutesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int minutes)
	Get a date in the past using a specified number of working minutes from a date. More...

DateTime	GetPastDateUsingWorkingSecondsForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int seconds)
	Get a date in the past using a specified number of working seconds from a date. More...

DateTime	GetPastDateUsingWorkingTimeForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days, int hours, int minutes, int seconds)
	Get a date in the past subtracting a specified working time from a date. More...

ResourceProcessSkillLevelCollection	GetProcessSkillLevelsForResource (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves all process skill levels assigned to a specified resource. More...

TeamProductivityInfo	GetProductivityForTeamResources (string sessionId, ResourceIdentity team)
	This API is deprecated and will not work on a clean install, since PI no longer is part of the KTA installation. This will only work on an installation which has been upgraded from 5.5 Retrieves the team productivity for a specified resource More...

string	GetResourceEmailAddress (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the email address of the specified resource More...

ResourceIdentity	GetResourceIdFromResourceIdentity (string sessionId, ResourceIdentity resourceIdentity)
	This function is deprecated. Please use GetResourceIdFromResourceIdentity2 instead. Retrieves the resource id from the specified resource's name More...

ResourceIdentity	GetResourceIdFromResourceIdentity2 (string sessionId, ResourceIdentity2 resourceIdentity)
	Retrieves the resource id from resource information More...

string	GetResourceName (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves a resource's name from its Id. More...

int	GetResourceNoteCount (string sessionId, ResourceIdentity ownerId, short status)
	Retrieves the number of notes assignd to the specified resource. More...

ResourceSummaryCollection	GetResources (string sessionId, ResourceFilter resourceFilter, ResourceIconSettings resourceIconSettings)
	This function is deprecated. Please use GetResources2 instead. Retrieves all resources based on a specified filter criteria More...

ResourceSummaryCollection	GetResources2 (string sessionId, ResourceFilter2 resourceFilter, ResourceIconSettings resourceIconSettings)
	Retrieves all resources based on a specified filter criteria. More...

ResourceIdentity2Collection	GetResourcesEmailAddresses (string sessionId, ResourceIdentityCollection resources)
	Retrieves the email address for each specified resource. More...

ResourceProcessSkillLevelCollection	GetResourceSkillLevelsForProcess (string sessionId, ProcessIdentity processIdentity)
	Retrieves all Resource Process Skill Levels set up for a specified process. More...

ResourceOnLoanCollection	GetResourcesOnLoanBetweenDates (string sessionId, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroup)
	Retrieves details of all resources on loan to a specified group between the given dates. More...

ResourceSummary	GetResourceSummary (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves summary details of the specified resource. More...

ResourceIdentity	GetResourceSupervisor (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the supervisor of the specified resource. More...

ResourceSummaryCollection	GetResourcesUsingSearchCriteria (string sessionId, ResourceSearchFilter resourceSearchFilter)
	Method to return a list of Resource details depending on the parameters passed into the method These parameters will be used as criteria for the returned list to be based upon. More...

ResourceIdentity	GetResourceWorkingGroup (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the working group assigned to the specified resource. More...

ResourceIdentityCollection	GetRoleMembers (string sessionId, ResourceIdentity roleIdentity)
	Retrieves a list of the resources that are members of a specified role. More...

SkillLevelHistoryCollection	GetSkillLevelHistory (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processIdentity)
	Retrieves the history of the skill level of a specified resource. More...

SkillLevel	GetSkillLevelOfResourceForProcess (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processIdentity)
	Retrieves the skill level for a speciified resource within a specified process. More...

SubordinateCollection	GetSubordinateGroups (string sessionId, ResourceIdentity groupResource, bool recursiveGroups)
	Retrieves a list of groups for which the specified resource is the supervisor. Subordinates of those groups can also be returned. More...

SubordinateCollection	GetSubordinates (string sessionId, ResourceIdentity resource, SubordinateFilter subordinateFilter)
	This function is deprecated. Please use GetSubordinates2 instead. Retrieves all direct worker subordinates of the specified resource More...

SubordinateCollection	GetSubordinates2 (string sessionId, ResourceIdentity resource, SubordinateFilter2 subordinateFilter)
	Retrieves all direct worker subordinates of the specified resource More...

SubordinateCollection	GetSupervisors (string sessionId, SupervisorFilter supervisorFilter)
	Retrieves all the supervisors based on the specified search filter criteria More...

WorkAllocationRule	GetWorkAllocationRuleForGroup (string sessionId, ResourceIdentity groupIdentity)
	Retrieves the work allocation rule details assigned to the specified resource. More...

WorkerGroupResource	GetWorkerGroupResource (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the full details of the specified resource. More...

WorkerResource	GetWorkerResource (string sessionId, ResourceIdentity resourceIdentity)
	This function is deprecated. Please use GetWorkerResource2 instead. Retrieves the full details of a worker resource. More...

WorkerResource2	GetWorkerResource2 (string sessionId, ResourceIdentity resource)
	Gets the full details of the specified resource. More...

CategoryIdentity	GetWorkingCategory (string sessionId, ResourceIdentity resourceIdentity)
	Retrieves the working category details of the specified resource. More...

int	GetWorkingDaysBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity)
	Retrieves the number of working days between two specified dates for a specified resource. More...

int	GetWorkingHoursBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity)
	Retrieves the number of working hours between two specified dates for a specified resource. More...

TimePeriod	GetWorkingHoursBreakdownForResource (string sessionId, ResourceIdentity resourceIdentity, int hours)
	Converts the specified number of hours into a resource's working time. More...

int	GetWorkingMinutesBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity)
	Retrieves the number of working minutes between two specified dates for a specified resource. More...

TimePeriod	GetWorkingMinutesBreakdownForResource (string sessionId, ResourceIdentity resourceIdentity, int minutes)
	Converts the specified number of minutes into a resource's working time. More...

int	GetWorkingSecondsBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity)
	Retrieves the number of working seconds between two specified dates for a specified resource. More...

TimePeriod	GetWorkingSecondsBreakdownForResource (string sessionId, ResourceIdentity resourceIdentity, int seconds)
	Converts the specified number of seconds into a resource's working time. More...

TimePeriod	GetWorkingTimeBetweenDatesForResource (string sessionId, ResourceTimeFilter resourceTimeFilter)
	Retrieves the working time between two specified dates for a specified resource. More...

bool	IsExcludedFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity)
	Determines whether the resource has been excluded from muanl work allocation using ExcludeFromManualWorkAllocation method. More...

bool	IsResourceInGroup (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity groupIdentity)
	Determines whether the specified resource is in the specified group More...

bool	IsWorkingDateTimeForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime dateToCheck)
	Determines whether the specified datetime is a working day for a specified resource. More...

bool	IsWorkingDayForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime dateToCheck)
	Determines whether the specified date is a working day for the resource. More...

LdapSynchonizationErrors	ProcessLdapSynchronizationErrors (string sessionId, LdapSynchronizationData synchronizationData)
	Processes the specified LDAP synchronization errors. More...

void	RemoveExclusionFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity)
	Allow resource to be available for manual work allocation. More...

void	RemoveResourceFromGroup (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity groupIdentity)
	Removes the specified resource from the specified group. More...

bool	RemoveSkillLevelForResourceAndProcess (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processIdentity, string comments)
	Removes the existing skill level for a specified resource for a specified process More...

void	RemoveSubordinatesExclusionFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity)
	Removes exclusion from manual work allocation for each resource that is a subordinate of the specified resource. More...

void	RemoveWorkAllocationRuleFromGroup (string sessionId, ResourceIdentity groupIdentity, WorkAllocationRuleIdentity ruleIdentity)
	Removes the specified work allocation rule from the specified group. More...

LdapSynchronizationResult	SynchronizeWithLdap (string sessionId, LdapSynchronizationSettings settings)
	Synchronizes the with an LDAP Server in order to retrieve a list of users which will be added to the resources available within TotalAgility. More...

void	UnDelegate (string sessionId, ResourceIdentity delegator)
	Removes any delegation from the specified resource. More...

void	UpdateCaseParticipant (string sessionId, WorkerResource resource)
	Please note that this function is deprecated. Please use UpdateCaseParticipant2 instead. Updates the details for for specified case participant. More...

void	UpdateCaseParticipant2 (string sessionId, UpdatedCaseParticipant resource, bool overwrite)
	Updates the case participants for a specified resource. More...

void	UpdateDelegation (string sessionId, DelegateInfo delegateInfo, bool overwrite)
	Updates the specified delegation and optionally overwrites it More...

void	UpdateExternalWorkerGroupResource (string sessionId, WorkerGroupResource resource, bool overwrite)
	This method is deprecated. Please use UpdateCaseParticipant2 instead More...

void	UpdateNotesStatus (string sessionId, NoteIdentityCollection noteIdCollection, short status)
	Updates the status of all the specified notes to either read or unread. More...

void	UpdateResourceSupervisor (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity supervisorIdentity)
	Assigns a supervisor to the specified resource, replacing any existing supervisor. More...

void	UpdateResourceWorkingGroup (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity workingGroup)
	Assigns the specified working group to the specified respurce, replacing any existing working group. More...

void	UpdateWorkerGroupResource (string sessionId, WorkerGroupResource resource, bool overwrite)
	Please note that this function is deprecated. Please use UpdateWorkerGroupResource2 instead. Updates the worker group resource information, optionally replacing any existing information. More...

void	UpdateWorkerGroupResource2 (string sessionId, WorkerGroupResource2 resource, bool overwrite)
	Updates the worker group resource information, optionally replacing any existing information. More...

void	UpdateWorkerGroupResource3 (string sessionId, WorkerGroupResource2 resource, ResourceIdentityCollection addMembers, ResourceIdentityCollection removeMembers, bool overwrite)
	Updates the worker group resource information using the addMember and removeMembers parameters. More...

void	UpdateWorkerResource (string sessionId, WorkerResource resource, bool overwrite)
	This function is deprecated. Please use UpdateWorkerResource2 instead. Updates the worker resource information with the specified information. More...

void	UpdateWorkerResource2 (string sessionId, WorkerResource2 resource, bool overwrite)
	Updates a resource based on the specified details. More...

void	UpdateWorkerResource3 (string sessionId, WorkerResource2 resource, ResourceIdentityCollection addToGroups, ResourceIdentityCollection removeFromGroups, bool overwrite)
	Updates a resource based on the specified details. More...

Description

Provides methods to manage resources and resource notes, delegate work between resources, and get working dates/times for a resource.

Member Functions

ResourceIdentity AddCaseParticipant	(	string	sessionId,
		WorkerResource	resource
	)

This function is deprecated. Please use AddCaseParticipant3 instead
Adds a new resource based on the resource supplied.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource object containing the details of the case particpant to add.

Name	Type	Comment	Required
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime?	Date the resource is valid from	No
EndDate	DateTime?	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Id or Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	Yes
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	No
NTName	String	Resource's name in the Windows environment	No
GroupId	Identity	The group the resource is to be attached to	No
Supervisor	Identity	Resource's supervisor id	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

Returns

A ResourceIdentity that describes the newly added participant.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	The resource type of the user. Defaults to ExternalWorker (32)

Remarks: If start and end date are not specified then the new resource will never expire
If only the start date is specified then the resource will be valid indefinitely from that date
If only the end date is specified then the resource will be valid immediately and until the specified date

Security: No restrictions apply.

ResourceIdentity AddCaseParticipant2	(	string	sessionId,
		CaseParticipant	caseParticipant
	)

This function is deprecated. Please use AddCaseParticipant4 instead
Adds a new resource based on the given participant's details

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

caseParticipant

A CaseParticipant object containing the details of the case particpant to add.

Name	Type	Comment	Required
Name	String	Name of participant	Yes
Category	Identity	The category to be assigned to the resource	Yes - Id or Name is required
EmailAddress	String	Email address of participant	Yes
Password	String	Participant's password	No
StartDate	DateTime?	Date the resource is valid from	No
EndDate	DateTime?	Date the resource is valid to	No

Returns

A ResourceIdentity that describes the newly added participant.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	The resource type of the user. Defaults to ExternalWorker (32)

Remarks: If start and end date are not specified then the new resource will never expire
If only the start date is specified then the resource will be valid indefinitely from that date
If only the end date is specified then the resource will be valid immediately and until the specified date

Security: No restrictions apply.

void AddCaseParticipant3	(	string	sessionId,
		CaseParticipant2	resource
	)

This function is deprecated. Please use AddCaseParticipant4 instead
Adds a new resource based on the given participant's details

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A CaseParticipant2 object containing the details of the case particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Details of the resource's persona	No
LastModifiedDate	DateTime	Date the resource is valid from	No
Name	String	Name of participant	Yes
Category	Identity	The category to be assigned to the resource	Yes - Id or Name is required
EmailAddress	String	Email address of participant	Yes
Password	String	Participant's password	No
StartDate	DateTime?	Date the resource is valid from	No
EndDate	DateTime?	Date the resource is valid to	No

Security: No restrictions apply.

ResourceIdentity AddCaseParticipant4	(	string	sessionId,
		CaseParticipant2	resource
	)

Adds a new resource based on the given participant's details

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A CaseParticipant2 object containing the details of the case particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Details of the resource's persona	No
LastModifiedDate	DateTime	Date the resource is valid from	No
Name	String	Name of participant	Yes
Category	Identity	The category to be assigned to the resource	Yes - Id or Name is required
EmailAddress	String	Email address of participant	Yes
Password	String	Participant's password	No
StartDate	DateTime?	Date the resource is valid from	No
EndDate	DateTime?	Date the resource is valid to	No

Returns

An instance of type ResourceIdentity containing the resource id information.

Name	Type	Comment
Id	String	Id of the resource.
Name	String	Name of the resource.
Resource Type	Int16	The resource type of the user.

Security: No restrictions apply.

void AddExternalWorkerGroupResource	(	string	sessionId,
		WorkerGroupResource	groupResource
	)

This method is deprecated. Please use AddCaseParticipant3 instead

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
groupResource	A WorkerGroupResource that identifies the group to be added.

Security: Resource must have at least Read Write access permission on Resource ACL.

string AddNote	(	string	sessionId,
		ResourceIdentity	ownerId,
		string	subject,
		string	noteText
	)

Adds a note to the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

ownerId

A ResourceIdentity object to add the note to.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

subject The title of the note. This must be specified.

noteText The body of the note. This must be specified.

Returns: A string containing the Id of the newly created note.

Security: No restrictions apply.

ResourceIdentity AddWorkerGroupResource	(	string	sessionId,
		WorkerGroupResource	resource
	)

Adds a new group resource based on the information provided.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerGroupResource object containing the details of the case particpant to add.

Name	Type	Comment	Required
AssoicatedResources	Collection	Not used. Please use AddWorkerGroupResourceMember to add members to the group.	No
WorkAllocationRule	Identity	Specify a Work Allocation Rule to associate with the group.	No
Identity	Identity	The name of the group to be added.	Yes - Name is required
Category	Identity	The category that the group belongs to.	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource.	Yes
SkillLevelMax	Int32	Maximum skill level of the resource.	Yes
SkillLevelMin	Int32	Minimum skill level of the resource.	Yes
EmailAddress	String	Email address of participant.	Yes
Supervisor	Identity	Details of the resource's supervisor.	No
LastModifiedUser	Identity	The last user to modify the resource.	No
LastModifiedDate	DateTime	Date the resource was last modified.	No
NTName	String	Resource's name in the Windows environment.	No
GroupId	Identity	The group the resource is to be attached to.	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information.	No

Returns

A ResourceIdentity that has the Id and Name of the newly created group.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	Always returns 0

Remarks: Email addresses must be unique for each resource

Security: Resource must have at least Read Write access permission on Resource ACL.

void AddWorkerGroupResourceMember	(	string	sessionId,
		ResourceIdentity	groupResource,
		ResourceIdentity	memberResource
	)

Adds an existing resource to the specified group

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

groupResource

A ResourceIdentity the group to add the resource to.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

memberResource

A ResourceIdentity the resource to be added.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Security: Resource must have at least Read Write access permission on Resource ACL.

ResourceIdentity AddWorkerResource	(	string	sessionId,
		WorkerResource	resource
	)

This function is deprecated. Please use AddWorkerResource2 instead.
Adds a resource with the specified details.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource object containing the details of the resource to add

Name	Type	Comment	Required
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	No
SkillLevelMax	Int32	Maximum skill level of the resource	No
SkillLevelMin	Int32	Minimum skill level of the resource	No
EmailAddress	String	Email address of participant	Yes
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	No
NTName	String	Resource's name in the Windows environment	Yes - see remarks
GroupId	Identity	The group the resource is to be attached to	No
Supervisor	Identity	Resource's supervisor id	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

Returns

An instance of type ResourceIdentity containing the resource id information.

Name	Type	Comment
Id	String	Id of the resource.
Name	String	Name of the resource.
Resource Type	Int16	The resource type of the user.

Remarks: NTName is only required if Resource Type is either Worker or ExternalWorker.
If Identity -> Name is specified, and already exists in the system an error will occur.
If Identity -> Id is specified, and already exists in the system, then the associated resource will be updated instead of a new one being created.

Security: Resource must have at least Read Write access permission on Resource ACL.

void AddWorkerResource2	(	string	sessionId,
		WorkerResource2	resource
	)

Please note that this function is deprecated. Please use AddWorkerResource3 instead.
Adds a resource using the specified details.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource2 object containing the details of the resource particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Not used and should not be set	No
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	No
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	No
NTName	String	Resource's name in the Windows environment	Yes - If Resource Type is set to Worker or ExternalUser
Resource Type	Int16	Type of the resource	No
GroupId	Identity	The group the resource is to be attached to	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

Remarks: If Identity -> ResourceType and ResourceType are both specified then the latter will take precendence. Both default to Worker

Security: Resource must have at least Read Write access permission on Resource ACL.

ResourceIdentity AddWorkerResource3	(	string	sessionId,
		WorkerResource2	resource
	)

Adds a resource using the specified details.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource2 object containing the details of the resource particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Not used and should not be set	No
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in If not Provided will use assigned Category	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	No
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	No
NTName	String	Resource's name in the Windows environment	Yes - If Resource Type is set to Worker or ExternalUser
Resource Type	Int16	Type of the resource	No
GroupId	Identity	The group the resource is to be attached to	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

Returns

An instance of type ResourceIdentity containing the resource id information.

Name	Type	Comment
Id	String	Id of the resource.
Name	String	Name of the resource.
Resource Type	Int16	The resource type of the user.

Remarks: If Identity -> ResourceType and ResourceType are both specified then the latter will take precendence. Both default to Worker

Security: Resource must have at least Read Write access permission on Resource ACL.

ResourceIdentity AddWorkerResource4	(	string	sessionId,
		WorkerResource2	resource,
		ResourceIdentityCollection	addToGroups
	)

Adds a resource using the specified details. Also can specify groups that the resource should be added to using the addToGroups parameter

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource2 object containing the details of the resource particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Not used and should not be set	No
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in If not Provided will use assigned Category	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	No
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	No
NTName	String	Resource's name in the Windows environment	Yes - If Resource Type is set to Worker or ExternalUser
Resource Type	Int16	Type of the resource	No
GroupId	Identity	The group the resource is to be attached to	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

addToGroups A collection that indicates groups the resource is to be added to

Returns

An instance of type ResourceIdentity containing the resource id information.

Name	Type	Comment
Id	String	Id of the resource.
Name	String	Name of the resource.
Resource Type	Int16	The resource type of the user.

Remarks: If Identity -> ResourceType and ResourceType are both specified then the latter will take precendence. Both default to Worker

Security: Resource must have at least Read Write access permission on Resource ACL.

DateTime ApplySkillLevelToResourceAndProcess	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ProcessIdentity	processId,
		SkillLevel	skillLevel,
		string	comments,
		bool	overwrite
	)

Assigns a skill level for a specified process to a specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id to identify the resource

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

processId

A processID object containing the process id to identify the process

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Use to indicate a specific version	No
Name	String	Name of the process	Yes - if Id is not specified

skillLevel

A SkillLevel object containing the Skill Level information.

Name	Type	Comment	Required
Level	Int16	Between 1 and 10	Yes
Name	String	The name of the skill level?	No
LastModifiedDate	DateTime	The date the process was last modified	Yes

comments Comments are not used

overwrite If set to true then any existing skill level will be overwritten.

Returns: Returns a DateTime that has gthe details of when the update was made.

Remarks: At run-time, activities within a process are only assigned to resources that have the required skill. This helps to assign the right work to the right resource, therefore the work is assigned to the resource with the correct training and skill level to perform it
If auditing is enabled, a new audit entry will be created with details of the skill assigned
For ResourceIdentity if Id and Name are both specified then Id will take precendence

Security: No restrictions apply.

void AssignWorkAllocationRuleToGroup	(	string	sessionId,
		ResourceIdentity	groupIdentity,
		WorkAllocationRuleIdentity	ruleIdentity
	)

Associates a work allocation rule to a group.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

groupIdentity

A ResourceIdentity object containing the resource id information of the group resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

ruleIdentity

A WorkAllocationRuleIdentity object containing the work allocation rule id information.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified

Security: No restrictions apply.

void DelegateFromTo	(	string	sessionId,
		ResourceIdentity	delegator,
		ResourceIdentity	delegatee,
		DelegationOptions	options
	)

Allows work to be delegated from one resource to another until a given date or indefinitely.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

delegator

A ResourceIdentity object containing the resource information of the delegator.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

delegatee

A ResourceIdentity object containing the resource information of the delegatee.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

options

A DelegationOptions object that is used to specify the optional end date of the delegation, and an option to overwrite any existing delegation between the delegator and delegatee.

Name	Type	Comment	Required
Overwrite	Boolean	Whether an existing delegation should be overwritten.	Yes - if EndDate is not specified
EndDate	DateTime	If specified, the date when the delegation will end	Yes - if Overwrite is not specified

Remarks: Only new activities will be available to the delegatee. Existing activities will be unaffected
Only activities assigned directly to the delegator will be available for the delegatee. Activities assigned to the delegator due to group membership are not delegated
When a delegation is in place, activities will be available on both the delegator and delegatee's work queue. Either resource can complete the assigned work

Security: No restrictions apply.

void DeleteResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		bool	checkMaps,
		bool	overrideSupervisorCheck
	)

Deletes the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource that needs to be deleted.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

checkMaps If set to true it checks the business process if the resource is being used and also its live activities.

overrideSupervisorCheck Indicator that the resource should be deleted even if it is being used as a supervisor.

Remarks: The Boolean parameters, checkMaps and overrideSupervisorCheck, default to false if not specified

Security: No restrictions apply.

bool DoesResourceExist	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Determines whether the specified resource exists.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information to check whether it exists or not.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: True if resource exists; false, otherwise.

Security: No restrictions apply.

bool DoesResourceHaveADelegatee	(	string	sessionId,
		ResourceIdentity	delegator
	)

Checks whether the specified resource is delegating thier activities to another resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

delegator

A ResourceIdentity object to be checked for a delegatee

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: True if the resource has a delegatee; false otherwise.

Security: No restrictions apply.

bool DoesResourceHaveDelegators	(	string	sessionId,
		ResourceIdentity	delegatee
	)

Checks whether the specified resource is assigned as a delagtee for any other resources.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

delegatee

A ResourceIdentity object to be checked for delegators.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: True if the resource has any delegators; false otherwise.

Security: No restrictions apply.

void ExcludeFromManualWorkAllocation	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Set ths resource as unavailable when doing Manual Work Allocation from the TotalAgility Workspace.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity specifying the resource that needs to be excluded from manual work allocation.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Remarks: To remove the exclusion use RemoveExclusionFromManualWorkAllocation.

Security: No restrictions apply.

ResourceSummaryCollection GetAssociatedGroups	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the groups associated with the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity specifying the resource to check.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A collection of type ResourceSummary that gives the details of each associated group

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image associated with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.

Security: No restrictions apply.

ProcessIdentityCollection GetAssociatedProcesses	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the associated processes for the specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object to check for associated processes.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A collection of ProcessIdentity associated to a resource.

Name	Type	Comment
Id	String	Id of the process
Version	Double	Version number of the process
Name	String	Name of the process

Security: No restrictions apply.

AvailableResources GetAvailableResourcesWithSkillLevelForActivities	(	string	sessionId,
		ProcessActivityIdentityCollection	activities,
		DateTime	startDate,
		DateTime	endDate
	)

This method is deprecated. Please use GetAvailableResourcesWithSkillLevelForActivities2 instead.
Retrieves the available resources with a sufficient skill level to perform the specified activities.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

activities

A collection of type ProcessActivityIdentity specifying the activitiesthat should be checked. At least one must be specified.

Name	Type	Comment	Required
ProcessIdentity	Identity	Object specifying the process to be checked	Yes - Id or Name is required
NodeID	Int16	Numeric Id of the node	No
ActivityName	String	Name of the Activity to be checked	No

startDate Only activities whose ActivityDueDate is after this will be eligible. This must be specified.

endDate Only activities whose ActivityDueDate is before this will be eligible. This must be specified.

Returns

An instance of type AvailableResources

Name	Type	Comment
OnLoanResources	A collection of OnLoanResourceAvailability	Contains details of any loaned resources that are elegible.
AvailableTeamResources	A collection of ResourceAvailability	Contains details of any loaned resources that are elegible.

Remarks: endDate must be later than startDate.

Security: No restrictions apply.

AvailableResources GetAvailableResourcesWithSkillLevelForActivities2	(	string	sessionId,
		JobActivityIdentityCollection	activities,
		DateTime	startDate,
		DateTime	endDate
	)

Retrieves the available resources with a sufficient skill level to perform the specified activities

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

activities

A collection of type JobActivityIdentity that will be checked for matching resources. At lewast one must be specified.

Name	Type	Comment	Required
ProcessIdentity	Identity	Object specifying the process to be checked	Yes - Id or Name is required
NodeID	Int16	Numeric Id of the node	No
ActivityName	String	Name of the Activity to be checked	No

startDate Only activities whose ActivityDueDate is after this will be eligible. This must be specified.

endDate Only activities whose ActivityDueDate is before this will be eligible. This must be specified.

Returns

An instance of type AvailableResources

Name	Type	Comment
OnLoanResources	A collection of OnLoanResourceAvailability	Contains details of any loaned resources that are elegible.
AvailableTeamResources	A collection of ResourceAvailability	Contains details of any loaned resources that are elegible.

Remarks: endDate must be later than startDate

Security: No restrictions apply.

ResourceAvailabilityCollection GetAvailableResourcesWithSkillLevelForProcess	(	string	sessionId,
		ResourceIdentity	onLoanGroupResourceIdentity,
		ProcessIdentity	processIdentity,
		short	skillLevel,
		DateTime	startDate,
		DateTime	endDate
	)

Retrieves a list of resources with the minimum skill level required for a specified process.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

onLoanGroupResourceIdentity

A ResourceIdentity object for any resources that are on loan and should also be checked

Name	Type	Comment	Required
Id	String	Id of the resource	No
Name	String	Not used	No
Resource Type	Int16	Not used	No

processIdentity

A ProcessIdentity object specifying the process that needs the resource

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Use to indicate a specific version	No
Name	String	Name of the process	Yes - if Id is not specified

skillLevel The minimum skill level of the resource.

startDate Specify this to get the resources that are assigned to the activities whose ActivityDueDate is after the StartDate.

endDate Specify this to get the resources that are assigned to the activities whose ActivityDueDate is before the EndDate.

Returns

A collection of type ResourceAvailability that lists all of the eligible resources.

Name	Type	Comment
OnLoanResources	A collection of OnLoanResourceAvailability	Contains details of any loaned resources that are elegible.
AvailableTeamResources	A collection of ResourceAvailability	Contains details of any loaned resources that are elegible.

Security: No restrictions apply.

CaseParticipant2 GetCaseParticipant	(	string	sessionId,
		ResourceIdentity	resource
	)

Gets a resource associated with a case based on the given participant's details.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A ResourceIdentity object containing the details of the case participant to retrieve

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A CaseParticipant2 object.

Name	Type	Comment
PersonaIdentity	Identity	Details of the resource's persona
LastModifiedDate	DateTime	Date the resource is valid from
Name	String	Name of participant
Category	Identity	The category to be assigned to the resource
EmailAddress	String	Email address of participant
Password	String	Participant's password
StartDate	DateTime?	Date the resource is valid from
EndDate	DateTime?	Date the resource is valid to

Security: No restrictions apply.

CategoryIdentity GetCategoryForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the Id and Name of the category assigned to a specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

The ResourceIdentity that specifies the resource to retrieve the ctaegory information from.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type CategoryIdentity containing the category information.

Name	Type	Comment
Id	String	Id of the category
Name	String	Name of the category

Security: No restrictions apply.

Model.Resources.Delegate GetDelegation	(	string	sessionId,
		ResourceIdentity	delegatorResource
	)

Retrieves the delegation for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

delegatorResource

A ResourceIdentity object to retrieve the delegation information from.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A Delegate that contains all the informtaion regarding the.

Name	Type	Comment
Delegator	ResourceIdentity	Id of the delegating resource.
Delegatee	ResourceIdentity	Id of the delegatee resource.
CreationDate	DateTime?	Date the delegation was created.
LastModifiedDate	DateTime?	Date the delegation was last modified.
EndDate	DateTime?	Date the delegation ends.
CreatedBy	ResourceIdentity	Id of the resource that created the delegation.
LastModifiedBy	ResourceIdentity	Id of the resource that last modified the delegation.

Remarks: The returned information only has the Ids for the Delegator and Delegatee not the Names.

Security: No restrictions apply.

DelegateInfoCollection GetDelegations ( string sessionId )

Retrieves a list of all delegations.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

Returns

A collection of type DelegateInfo.

Name	Type	Comment
Delegator	ResourceIdentity	Id of the delegating resource.
Delegatee	ResourceIdentity	Id of the delegatee resource.
CreationDate	DateTime?	Date the delegation was created.
LastModifiedDate	DateTime?	Date the delegation was last modified.
EndDate	DateTime?	Date the delegation ends.
CreatedBy	ResourceIdentity	Id of the resource that created the delegation.
LastModifiedBy	ResourceIdentity	Id of the resource that last modified the delegation.
OverWrite	Boolean	Will always return `false`.

Security: No restrictions apply.

LdapResourceCollection GetFailedToSynchLdapResourcesFromXml	(	string	sessionId,
		string	errorsXml
	)

Gets a list of the LDAP resources that failed to synchronize from the error output in XML.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
errorsXml	The XML error output of the LDAP synchronisation. This must be specified.

Returns

A collection of LdapResource that contains each resource that failed to sync.

Name	Type	Comment
LdapName	String	Name of the Ldap resource.
ResourceId	String	Id of the resource.
ErrorText	String	Error message
Email	String	Email address of the Ldap resource.
LdapFullPath	String	Fully qualified path of the Ldap resource.
LdapResourceType	String	The type of the Ldap resource.
Deleted	String	The deleted.

Remarks: This method will generally process output from SynchronizeWithLdap.

Security: Resource must have at least Read access permission on Resource ACL.

DateTime GetFutureDateUsingWorkingDaysForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	days
	)

Get a date in the future using a specified number of working days from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working days will be taken into account when calculating the future date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working days are added. This must be specified.

days Number of working days to add to the specified date.

Returns: Future date determined by the adding the working days to the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If the days parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetFutureDateUsingWorkingHoursForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	hours
	)

Get a date in the future using a specified number of working hours from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working days will be taken into account when calculating the future date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working hours are added. This must be specified

hours Number of working hours to add to the specified date.

Returns: Future date determined by the adding the working hours to the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If the hours parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetFutureDateUsingWorkingMinutesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	minutes
	)

Get a date in the future using a specified number of working minutes from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working days will be taken into account when calculating the future date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working minutes are added. This must be specified.

minutes Number of working minutes to add to the specified date.

Returns: Future date determined by the adding the working minutes to the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If the minutes parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetFutureDateUsingWorkingSecondsForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	seconds
	)

Get a date in the future using a specified number of working seconds from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working days will be taken into account when calculating the future date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working seconds are added. This must be specified.

seconds Number of working seconds to add to the specified date.

Returns: Future date determined by the adding the working seconds to the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If the seconds parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetFutureDateUsingWorkingTimeForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	days,
		int	hours,
		int	minutes,
		int	seconds
	)

Get a date in the future by adding a specified working time to a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

The resource identity.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working time is added. This must be specified.

days Number of working days to add to the specified date.

hours Number of working hours to add to the specified date.

minutes Number of working minutes to add to the specified date.

seconds Number of working seconds to add to the specified date.

Returns: Future date determined by the adding the working time to the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If any of the time parameteres (days, hours, minutes, seconds) are left blank they will default to 0.

Security: No restrictions apply.

ResourceSummaryCollection GetGroupResourceMembers	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the groups and workers associated with the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity specifying the resource to check.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A collection of type ResourceSummary that gives the details of each associated group

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image associated with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.

Security: No restrictions apply.

int GetLoanedSecondsForResourceBetweenDates	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		DateTime	toDate,
		ResourceIdentity	onLoanGroupIdentity
	)

Gets the number of seconds a resource has been on loan to a group.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resourceid information of the resource whose count of loaned seconds need to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Start date for the loan details retrieval. This must be specified.

toDate End date for the loan details retrieval. This must be specified.

onLoanGroupIdentity

Identity of group that resources are on loan to.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: The number of seconds the specified resource has been on loan to the specified group.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.

Security: No restrictions apply.

TimePeriod GetLoanedTimeForResourceBetweenDates	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		DateTime	toDate,
		ResourceIdentity	onLoanGroupIdentity
	)

Calculates the amount of time the specified resource is allocated as on loan to the specified group between the dates given.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrive the data for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Start date for the loan details retrieval. This must be specified.

toDate End date for the loan details retrieval. This must be specified.

onLoanGroupIdentity

Identity of group that resources are on loan to.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A TimePeriod that conatins the time in various different formats.

Name	Type	Comment
Days	In16	The number of days the resource was on loan for.
Hours	In16	The number of hours the resource was on loan for.
Minutes	In16	The number of minutes the resource was on loan for.
Seconds	In16	The number of seconds the resource was on loan for.
FormattedAsString	String	The TimePeriod in string format.
TotalSeconds	In16	Always 0
TotalMinutes	In16	Always 0

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.

Security: No restrictions apply.

NetTimeForResource GetLoanedTimeForResourcesBetweenDates	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		int	workloadInSeconds,
		DateTime	fromDate,
		DateTime	toDate,
		ResourceIdentity	onLoanGroup
	)

Works out a resource's total and net remaining working days on loan to a specified resource, taking into account a specifiable existing workload.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resourceid information of the resource whose loaned time need to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

workloadInSeconds The current workload of the resource, in seconds

fromDate From date. Must be specified.

toDate To date. Must be specified.

onLoanGroup

A ResourceIdentity object that specifies the group the resource is on loan to.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type NetTimeForResource.

Name	Type	Comment
TimeAvailableForWork	Model.TimePeriod	The amount of working time left in total between the dates.
TimeFreeForWorkAllocation	Model.TimePeriod	The amount of working time left in total after taking workloadInSeconds into account.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
The number of hours in the resources's working day is retrieved from the Business Calendar.

Security: No restrictions apply.

ResourceSummaryCollection GetMembersOfGroup	(	string	sessionId,
		ResourceIdentity	groupResourceId,
		bool	useManualWorkAllocationExclusion
	)

Retrieves the resources that are members of the specified group.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

groupResourceId

A ResourceIdentity object whose members will be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

useManualWorkAllocationExclusion if set to true whether to use the manual work allocation exclusions or not

Returns

A collection of ResourceSummary that has the details of each resource found.

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image assocaited with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise

Remarks: If useManualWorkAllocationExclusion is set to true then any members found that have been marked as excluded, using ExcludeFromManualWorkAllocation, will not be shown.

Security: No restrictions apply.

NetTimeForResource GetNetTimeBetweenDatesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		int	workloadInSeconds,
		DateTime	fromDate,
		DateTime	toDate,
		ResourceIdentity	onLoanGroupIdentity
	)

Works out the amount of time a resource will be available between the dates specified, taking into account a specifiable existing work load.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrive the data for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

workloadInSeconds The current workload of the resource, in seconds.

fromDate Start date for calculation. Must be specified.

toDate End date for the calculation. Must be specified.

onLoanGroupIdentity

A ResourceIdentity object that specifies the group the resource is on loan to.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type NetTimeForResource.

Name	Type	Comment
TimeAvailableForWork	Model.TimePeriod	The amount of working time left in total between the dates.
TimeFreeForWorkAllocation	Model.TimePeriod	The amount of working time left in total after taking workloadInSeconds into account.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
The number of hours in the resources's working day is retrieved from the Business Calendar.
The returned data has two parts:

Security: No restrictions apply.

NoteCollection GetNotes	(	string	sessionId,
		ResourceIdentity	ownerId,
		NoteFilter	noteFilter
	)

Retrieves the notes for the specified resource using specified note filter.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

ownerId

A ResourceIdentity object containing the resource id information of the resource whose notes need to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

noteFilter

A NoteFilter object containing the filter criteria to retrieve the notes.

Name	Type	Comment	Required
NoteStatus	Int16	The type of notes to be retrieved	No
From	DateTime?	Only notes after this date	No
To	DateTime?	Only notes before this date	No

Returns

A collection of Note.

Name	Type	Comment
Id	String	Id of the note
OwnerId	String	Id of the resource the note is attached to
CreatorId	String	The Id of the resource that created the note
NoteTypeDescription	String	Text description of type of note
OwnerName	String	Name of the resource the note is attached to
Text	String	The text of the note
Subject	String	The subject of the note
Status	Int16	1 for unread, 2 for read
CreatorName	String	The name of the resource that created the note
StatusDisplayText	String	Unread or read
StatusImageUrl	String	Path to image for status of the note
CreationDate	DateTime	The date the note was created
LastModifiedDate	DateTime	The date the note was last amended

Security: No restrictions apply.

long GetNumberOfActivitiesAssignedToResource	(	string	sessionId,
		ResourceActivityFilter	resourceActivityFilter
	)

Gets the number of activities assigned to the specified resource.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
resourceActivityFilter	A ResourceActivityFilter object containing the filter criteria to retrieve the activities.

Name	Type	Comment	Required
ResourceIdentity	Identity	The resource to retrieve the data for.	Yes - Id or Name is required
useActivityName	Boolean	Indicates whether the name of the activitiy should be used.	No
ActivityName	String	The name of the activity.	No
useProcessId	Boolean	Indicates whether the process's Id should be used.	No
ProcessIdentity	Identity	The details of the process.	No
ResourcesIncluded	Int16	Indicator of the types of resources to be included in the count.	No

Returns: Number of activities assigned to resource

Remarks: If useActivityName / ActivityName are used then only activities of that name will be counted.
If useProcessId / processId are used then only activities belonging to the specified process will be counted.

Security: No restrictions apply.

DateTime GetPastDateUsingWorkingDaysForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	days
	)

Get a date in the past using a specified number of working days from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working days will be taken into account when calculating the past date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working days are subtracted. This must be specified.

days Number of working days to subtract from the specified date.

Returns: Past date determined by the subtracting the working days from the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If the days parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetPastDateUsingWorkingHoursForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	hours
	)

Get a date in the past using a specified number of working hours from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working hours will be taken into account when calculating the past date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working hours are subtracted. This must be specified.

hours Number of working hours to subtract from the specified date.

Returns: Past date determined by the subtracting the working hours from the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working hours to be taken into account.
If the hours parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetPastDateUsingWorkingMinutesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	minutes
	)

Get a date in the past using a specified number of working minutes from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working minutes will be taken into account when calculating the past date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working minutes are subtracted.

minutes Number of working minutes to subtract from the specified date.

Returns: Past date determined by the subtracting the working minutes from the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working minutes to be taken into account.
If the minutes parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetPastDateUsingWorkingSecondsForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	seconds
	)

Get a date in the past using a specified number of working seconds from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object whose working seconds will be taken into account when calculating the past date.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working seconds are subtracted. This must be specified.

seconds Number of working seconds to subtract from the specified date.

Returns: Past date determined by the subtracting the working seconds from the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working seconds to be taken into account.
If the seconds parameter is left blank it will default to 0 and the original fromDate will be returned.

Security: No restrictions apply.

DateTime GetPastDateUsingWorkingTimeForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		int	days,
		int	hours,
		int	minutes,
		int	seconds
	)

Get a date in the past subtracting a specified working time from a date.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

The resource identity.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate Date onto which the working time is subtracted. This must be specified.

days Number of working days to subtract from the specified date.

hours Number of working hours to subtract from the specified date.

minutes Number of working minutes to subtract from the specified date.

seconds Number of working seconds to subtract from the specified date.

Returns: Past date determined by subtracting the working time from the specified date.

Remarks: The system setting 'Use Business Calendar', under Work Process, must be turned on in order the the resource's working days to be taken into account.
If any of the time parameteres (days, hours, minutes, seconds) are left blank they will default to 0.

Security: No restrictions apply.

ResourceProcessSkillLevelCollection GetProcessSkillLevelsForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves all process skill levels assigned to a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object that specifies the resource to retrieve the skill levels for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A collection of type ResourceProcessSkillLevel.

Name	Type	Comment
Identity	Identity	The Id, Name and ResourceType the skill is applied to
Process	Identity	The Id and Name of the process the skill is applied to
SkillLevel	Int32	The level of the skill
SkillLevelName	String	Text version of the skill level
Comment	String	Comment for the skilll level
LastModifiedDate	DateTime	The date the skill level was last amended

Remarks: Process skill levels are assigned in the TotalAgility Workspace.

Security: No restrictions apply.

TeamProductivityInfo GetProductivityForTeamResources	(	string	sessionId,
		ResourceIdentity	team
	)

This API is deprecated and will not work on a clean install, since PI no longer is part of the KTA installation.
This will only work on an installation which has been upgraded from 5.5 Retrieves the team productivity for a specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

team

A ResourceIdentity object containing the resource id information of the team whose productivity for team resources needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: An instance of type TeamProductivityInfo.

Security: No restrictions apply.

string GetResourceEmailAddress	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the email address of the specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource whose email address needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: A string containing the email address of the resource.

Security: No restrictions apply.

ResourceIdentity GetResourceIdFromResourceIdentity	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

This function is deprecated. Please use GetResourceIdFromResourceIdentity2 instead.
Retrieves the resource id from the specified resource's name

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource name information of the resource to retrieve the resource id.

Name	Type	Comment	Required
Id	String	Id of the resource	No
Name	String	Not used	Yes
Resource Type	Int16	Not used	No

Returns

An instance of type ResourceIdentity.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Not populated
Resource Type	Int16	Not populated

Security: No restrictions apply.

ResourceIdentity GetResourceIdFromResourceIdentity2	(	string	sessionId,
		ResourceIdentity2	resourceIdentity
	)

Retrieves the resource id from resource information

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity2 object containing the resource name information of the resource to retrieve the resource id.

Name	Type	Comment	Required
EmailAddresss	String	The resource's emaill address.	Yes - if UserId and Name are not specified
UserId	String	The resource's NTName.	Yes - if EmailAddresss and Name are not specified
Id	String	The Id string of the resource.	No
Name	String	The resource's name.	Yes - if EmailAddresss and UserId are not specified
ResourceType	Int16	The type of the resource.	No

Returns

An instance of type ResourceIdentity.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	The type of the resource

Remarks: If resourceIdentity -> EmailAddress, UserId and Name are all specified then Name will be checked first, followed by UserId then EmailAddress.

Security: No restrictions apply.

string GetResourceName	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves a resource's name from its Id.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource to retrieve the name.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes
Name	String	Not used	No
Resource Type	Int16	Not used	No

Returns: A string containing the resource's name.

Security: No restrictions apply.

int GetResourceNoteCount	(	string	sessionId,
		ResourceIdentity	ownerId,
		short	status
	)

Retrieves the number of notes assignd to the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

ownerId

A ResourceIdentity object containing the resource id information of the resource to retrieve the note count.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

status The type of notes to count.

Returns: Number of notes of the specified resource

Remarks: Notes are added to a resource by using the AddNote method.
status defaults to All notes

Security: No restrictions apply.

ResourceSummaryCollection GetResources	(	string	sessionId,
		ResourceFilter	resourceFilter,
		ResourceIconSettings	resourceIconSettings
	)

This function is deprecated. Please use GetResources2 instead.
Retrieves all resources based on a specified filter criteria

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceFilter

A ResourceFilter object containing the filter criteria to retrieve the resources.

Name	Type	Comment	Required
resourceIdentity	Identity	Use to specify a particular resource	No
categoryIdentity	Identity	Use to get all the resources from a category	No
OrderByName	Boolean	Set to `true` to order the list that is returned	No
UseSkillLevel	Boolean	Not used	No
UseSecurityLevel	Boolean	Not used	No
Resource Type	Int16	Use to specify a particular type of resource	No
SearchText	Boolean	Set to `true` to order the list that is returned	No

resourceIconSettings A ResourceIconSettings object containing the resource icon settings to retrieve the icon URL. This is NOT used.

Returns

A collection of type ResourceSummary.

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image assocaited with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.

Remarks: If no parameters other than sessionId are specified then the method will return a list of the groups.
If any other option is specified then all resources are searched.
If OrderByName is set to true then the list will be ordered by resource type and then by name.
Setting UseSkillLevel or UseSecurityLevel has no effect other than to return all resources.
SearchText will only find resources that contain the specified text

Security: No restrictions apply.

ResourceSummaryCollection GetResources2	(	string	sessionId,
		ResourceFilter2	resourceFilter,
		ResourceIconSettings	resourceIconSettings
	)

Retrieves all resources based on a specified filter criteria.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceFilter

A ResourceFilter2 object containing the filter criteria to retrieve the resources.

Name	Type	Comment	Required
GroupResourceIdentity	Identity	Use to specify a particular resource	No
SecurityLevelMax	Int16	Filter based on maximum security level	No
SkillLevelMax	Int16	Filter based on maximum skill level	No
SkillLevelMin	Int16	Filter based on minimum skill level	No
GetResourcesInSubcategories	Boolean	Set to `true` to order for subcategories to be included	No
GetRuntimeResources	Boolean	Set to `true` to order to get resources added at runtime	No
resourceIdentity	Identity	Use to specify a particular resource	No
categoryIdentity	Identity	Use to get all the resources from a category	No
OrderByName	Boolean	Set to `true` to order the list that is returned	No
UseSkillLevel	Boolean	If `false` then SkillLevelMin and SkillLevelMax will be ignored	No
UseSecurityLevel	Boolean	If `false` then SecurityLevelMax will be ignored	No
Resource Type	Int16	Use to specify a particular type of resource	No
SearchText	Boolean	Set to `true` to order the list that is returned	No

resourceIconSettings A ResourceIconSettings object containing the resource icon settings to retrieve the icon URL. This is NOT used.

Returns

A collection of type ResourceSummary.

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image assocaited with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.

Remarks: If no parameters other than sessionId are specified then the method will return a list of the groups.
If any other option is specified then all resources are searched.
If OrderByName is set to true then the list will be ordered by resource type and then by name. SearchText will only find resources that contain the specified text

Security: No restrictions apply.

ResourceIdentity2Collection GetResourcesEmailAddresses	(	string	sessionId,
		ResourceIdentityCollection	resources
	)

Retrieves the email address for each specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resources

A collection of type ResourceIdentity from which to retrieve the email addresses. At least one must be specified.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: A collection of ResourceIdentity2.

Security: No restrictions apply.

ResourceProcessSkillLevelCollection GetResourceSkillLevelsForProcess	(	string	sessionId,
		ProcessIdentity	processIdentity
	)

Retrieves all Resource Process Skill Levels set up for a specified process.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

processIdentity

A ProcessIdentity object containing the process id information of the process whose resource skill levels need to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Use to indicate a specific version	No
Name	String	Name of the process.	Yes - if Id is not specified

Returns

A collection of type ResourceProcessSkillLevel.

Name	Type	Comment
Identity	Identity	The Id, Name and ResourceType off the resource the skill is applied to
Process	Identity	The Id and Name of the process the skill is applied to
SkillLevel	Int32	The level of the skill
SkillLevelName	String	Text version of the skill level
Comment	String	Comment for the skilll level
LastModifiedDate	DateTime	The date the skill level was last amended

Remarks: Resource Process Skill Levels are set up in the TotalAgility Workspace.

Security: No restrictions apply.

ResourceOnLoanCollection GetResourcesOnLoanBetweenDates	(	string	sessionId,
		DateTime	fromDate,
		DateTime	toDate,
		ResourceIdentity	onLoanGroup
	)

Retrieves details of all resources on loan to a specified group between the given dates.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

fromDate Start date for the loan details retrieval. Must be specified.

toDate End date for the loan details retrieval. Must be specified.

onLoanGroup

A ResourceIdentity object specifying the group to retrieve details from.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A collection of ResourceOnLoan.

Name	Type	Comment
Identity	Identity	The Id, Name and ResourceType of the resource on loan
Server	Identity	The Id and Name of the server
OnLoanToGroup	Identity	The Id, Name and ResourceType of the group the resource is on loan to
OnLoanDate	DateTime?	The date the resource is on loan.
EmailAddress	String	Email address of the resource that is on loan
TotalDurationInMinutes	Int64	The number of minutes the resource is on loan on OnLoanDate
DurationHours	Int16	Not populated
DurationMins	Int16	Not populated
DayOfWeek	Int16	Not populated

Remarks: fromDate and toDate must be between 01-Jan-1753 and 31-Dec-9999.

Security: No restrictions apply.

ResourceSummary GetResourceSummary	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves summary details of the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource whose resource summary information needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type ResourceSummary containing the resource information.

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image assocaited with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.

Security: No restrictions apply.

ResourceIdentity GetResourceSupervisor	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the supervisor of the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource whose supervisor information needs to be retrieved.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type ResourceIdentity.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	Not populated

Security: No restrictions apply.

ResourceSummaryCollection GetResourcesUsingSearchCriteria	(	string	sessionId,
		ResourceSearchFilter	resourceSearchFilter
	)

Method to return a list of Resource details depending on the parameters passed into the method These parameters will be used as criteria for the returned list to be based upon.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceSearchFilter

A ResourceSearchFilter object containing the filter criteria to retrieve the resources.

Name	Type	Comment	Required
SearchText	String	Text to filter the resource names by.	Yes
ServerIdentity	Identity	Id of the server to search.	No
Supervisor	Identity	Only search resources with this supervisor.	No
Group	Identity	Only search resources belonging to this group.	No
CategoryResource	Identity	This is NOT used.	No
CategoryIdentity	Identity	Category that resource belongs to.	No

Returns

A collection of type ResourceSummary.

Name	Type	Comment
Identity	Identity	Object containing the Id, Name and ResourceType of the resource
Category	Identity	Object containing the Id and Name of the category the resource belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
UserId	String	The NTName of the resource
ResourceImageUrl	String	Path to the image assocaited with the resource
ImageUrl	String	Always the same as ResourceImageUrl
EmailAddress	String	Email address of the resource
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.

Remarks: If filtering by name is not required then set ResourceSearchFilter -> SearchText to %.
If ResourceSearchFilter -> ServerId is not specified then it will default to the local server.

Security: No restrictions apply.

ResourceIdentity GetResourceWorkingGroup	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the working group assigned to the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource information to retrieve the working group.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type ResourceIdentity with the Id and Name of the working group.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	Not populated

Security: No restrictions apply.

ResourceIdentityCollection GetRoleMembers	(	string	sessionId,
		ResourceIdentity	roleIdentity
	)

Retrieves a list of the resources that are members of a specified role.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

roleIdentity

A ResourceIdentity object containing the resource information to retrieve the roles.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

A collection of ResourceIdentity.

Name	Type	Comment
Id	String	Id of the resource
Name	String	Name of the resource
Resource Type	Int16	Not populated

Security: No restrictions apply.

SkillLevelHistoryCollection GetSkillLevelHistory	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ProcessIdentity	processIdentity
	)

Retrieves the history of the skill level of a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource information to retrieve the skill level history.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

processIdentity

A ProcessIdentity object containing the process information to retrieve the skill level history.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Use to indicate a specific version	No
Name	String	Name of the process	Yes - if Id is not specified

Returns

A collection of SkillLevelHistory.

Name	Type	Comment
Identity	Identity	Id, Name and ResourceType that the skill level is attached to
LastModifiedBy	Identity	The resource that last modified the skill level
Category	Identity	Id and Name of the process the skill level is attached to
DateModified	DateTime	Date the skill level was last modified
Comment	String	Comment attached to the skill level

Security: No restrictions apply.

SkillLevel GetSkillLevelOfResourceForProcess	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ProcessIdentity	processIdentity
	)

Retrieves the skill level for a speciified resource within a specified process.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity specifying the resource to retrieve the skill level for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

processIdentity

A ProcessIdentity specifying the process to retrieve the skill level for.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Use to indicate a specific version	No
Name	String	Name of the process	Yes - if Id is not specified

Returns

A collection of type SkillLevel containing the skill level.

Name	Type	Comment
Level	Int16	The skill level of the resource
Name	String	Name attached to the skill level
LastModifiedDate	DateTime	The date the skill level was last modified
LastModifiedResource	Identity	Id, Name and ResourceType of the resource that last modifed the skill level

Remarks: Process skil levels are set up using the TotalAgility Workspace.

Security: No restrictions apply.

SubordinateCollection GetSubordinateGroups	(	string	sessionId,
		ResourceIdentity	groupResource,
		bool	recursiveGroups
	)

Retrieves a list of groups for which the specified resource is the supervisor. Subordinates of those groups can also be returned.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

groupResource

A ResourceIdentity object containing the resource id for which to retrieve the subordinate groups. worker resource should only be specified and not the group resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

recursiveGroups If set to true then each group found will also be checked for subordinates. Defaults to false.

Returns

A collection of type Subordinate.

Name	Type	Comment
Identity	ResourceIdentity	Id, Name and ResourceType that the skill level is attached to
Server	ServerIdentity	Id and Name of the server
DateModified	DateTime	Date the skill level was last modified
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.
EmailAddress	String	Email address of the subordinate group

Remarks

recursiveGroups	Resources returned
FALSE	Groups that have the specified resource as a supervisor.
TRUE	As above but groups that are members of those groups will also be returned and so on.

Security: No restrictions apply.

SubordinateCollection GetSubordinates	(	string	sessionId,
		ResourceIdentity	resource,
		SubordinateFilter	subordinateFilter
	)

This function is deprecated. Please use GetSubordinates2 instead.
Retrieves all direct worker subordinates of the specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A ResourceIdentity object containing the resource id to retrieve the subordinates.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

subordinateFilter

A SubordinateFilter object containing the filter criteria to retrieve the subordinates.

Name	Type	Comment	Required
IncludeUser	Boolean	Indicates whether the current user should be included.	No
UseManualWorkAllocationExclusion	Boolean	Indicates whether manual work allocation rules should be used.	No
UseGroupSubordinates	Boolean	Indicates whether subordinate groups should be included.	No
GetIndirectSubordinates	Boolean	Indicates whether indirect subordinates should be included.	No

Returns

A collection of type Subordinate.

Name	Type	Comment
Identity	Identity	Id, Name and ResourceType that the skill level is attached to
Server	Identity	Id and Name of the server
DateModified	DateTime	Date the skill level was last modified
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.
EmailAddress	String	Email address of the subordinate group

Security: No restrictions apply.

SubordinateCollection GetSubordinates2	(	string	sessionId,
		ResourceIdentity	resource,
		SubordinateFilter2	subordinateFilter
	)

Retrieves all direct worker subordinates of the specified resource

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A ResourceIdentity object containing the resource id to retrieve the subordinates.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

subordinateFilter

A SubordinateFilter2 object containing the filter criteria to retrieve the subordinates.

Name	Type	Comment	Required
UseManagerialLevel	Boolean	Indicates whether to use the specified managerial level.	No
ManagerialLevel	Int16	The managerial level to filter by.	No
UseCategory	Boolean	Indicates whether to use the specified category.	No
CategoryIdentity	Identity	The category to filter by.	No
IncludeUser	Boolean	Indicates whether current user should be included.	No
UseManualWorkAllocationExclusion	Boolean	Indicates whether manual work allocation rules should be used.	No
UseGroupSubordinates	Boolean	Indicates whether subordinate groups should be included.	No
GetIndirectSubordinates	Boolean	Indicates whether indirect subordinates should be included.	No

Returns

A collection of type Subordinate.

Name	Type	Comment
Identity	Identity	Id, Name and ResourceType that the skill level is attached to
Server	Identity	Id and Name of the server
DateModified	DateTime	Date the skill level was last modified
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.
EmailAddress	String	Email address of the subordinate group

Security: No restrictions apply.

SubordinateCollection GetSupervisors	(	string	sessionId,
		SupervisorFilter	supervisorFilter
	)

Retrieves all the supervisors based on the specified search filter criteria

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

supervisorFilter

A SupervisorFilter object containing the filter criteria to retrieve the supervisors.

Name	Type	Comment	Required
ResourceIdentity	Identity	The resource to find the supervisor of.	Yes - Id or Name is required
CategoryIdentity	Identity	The category to filter by.	Yes - Id or Name is required
ManagerialLevel	Int16	The managerial level to filter by.	No

Returns

A collection of type Subordinate

Name	Type	Comment
Identity	Identity	Id, Name and ResourceType that the skill level is attached to
Server	Identity	Id and Name of the server
DateModified	DateTime	Date the skill level was last modified
ManagerialLevel	Int16	1-10 if resource is a manager, 99 otherwise.
EmailAddress	String	Email address of the subordinate group

Security: No restrictions apply.

WorkAllocationRule GetWorkAllocationRuleForGroup	(	string	sessionId,
		ResourceIdentity	groupIdentity
	)

Retrieves the work allocation rule details assigned to the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

groupIdentity

A ResourceIdentity object containing the resource group id information to retrieve the work allocation rule.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An instance of type WorkAllocationRule that has the details of the Work Allocation Rule.

Name	Type	Comment
Identity	Identity	Id and Name of the Work Allocation Rule
Id	String	Id of the Work Allocation Rule
Name	String	The name of the rule
Description	String	The description of the rule
Category	Identity	Id and Name of the category that the rule belongs to
RuleData	Object	Details of the rule itself
LastModifiedResource	Identity	Id, Name and ResourceType that the skill level is attached to
LastModifiedDate	DateTime	Date the skill level was last modified

Remarks: Work allocation rules are set up in the TotalAgility Workspace.

Security: No restrictions apply.

WorkerGroupResource GetWorkerGroupResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the full details of the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id to retrieve the worker group resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes
Name	String	Not used	No
Resource Type	Int16	Not used	No

Returns

An instance of type WorkerGroupResource that contains the details of the group and its assocaiated resources

Name	Type	Comment
AssociatedResources	Collection	Collection of associated resources
WorkAllocationRule	Identity	Id and Name of the Work Allocation Rule associated with the resource
Identity	Identity	The Id, Name and ResourceType of the resource
Category	Identity	The category the group belongs to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the group
SkillLevelMin	Int32	Minimum skill level of the group
EmailAddress	String	Email address of the resource
Supervisor	Identity	Id, NAme and ResourceType of the resource's supervisor
LastModifiedUser	Identity	Id, NAme and ResourceType of the resource that last modifeid the specified resource
LastModifiedDate	DateTime	Date the resource was last modified
NTName	String	The resource's user name
resourceType	Int16	The type of the resource
GroupId	Identity	The Id, Name and ResourceType of the resource
ExtensionFields	Collection	Collection of fields that hold extra information

Security: No restrictions apply.

WorkerResource GetWorkerResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

This function is deprecated. Please use GetWorkerResource2 instead.
Retrieves the full details of a worker resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id to retrieve the worker resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes
Name	String	Not used	No
Resource Type	Int16	Not used	No

Returns

An instance of type Model.Resources.WorkerResource that contains all the details of the resource

Name	Type	Comment
FixedCostRate	Double	Fixed cost of the resource
VariableCostRate	Double	Variable cost of the resource
VariableCostPeriod	Double	Unit of time for variable costs
WorkingCategory	Identity	Category that the resource will be working in
Password	String	Resource's password
ManagerialLevel	Int16	Managerial level of the resource
WorkingGroup	Identity	Group the resource will be working in
StartDate	DateTime	Date the resource is valid from
EndDate	DateTime	Date the resource is valid to
PasswordChanged	Boolean	Indicates that the password has changed
Identity	Identity	Object containing the name of the resource to be added
Category	Identity	Category the resource should assigned to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
EmailAddress	String	Email address of participant
Supervisor	Identity	Resource's supervisor id
LastModifiedUser	Identity	The last user to modify the resource
LastModifiedDate	DateTime	Date the resource was last modified
NTName	String	Resource's name in the Windows environment
GroupId	Identity	The group the resource is to be attached to
Supervisor	Identity	Resource's supervisor id
ExtensionFields	Collection	Collection of ExtensionFields for any additional information

Security: No restrictions apply.

WorkerResource2 GetWorkerResource2	(	string	sessionId,
		ResourceIdentity	resource
	)

Gets the full details of the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

The resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns

An WorkerResource2 that contains the details of the resource.

Name	Type	Comment
PersonaIdentity	Identity	Details of the resource's persona
PersonaIdentity	Identity	The Id and Name of the associated Persona
FixedCostRate	Double	Fixed cost of the resource
VariableCostRate	Double	Variable cost of the resource
VariableCostPeriod	Double	Unit of time for variable costs
WorkingCategory	Identity	Category that the resource will be working in
Password	String	Resource's password
ManagerialLevel	Int16	1-10 if resource is a manager, 99 othwerwise
WorkingGroup	Identity	Group the resource will be working in
StartDate	DateTime?	Date the resource is valid from
EndDate	DateTime?	Date the resource is valid to
PasswordChanged	Boolean	Indicates that the password has changed
Identity	Identity	Object containing the name of the resource to be added
Category	Identity	Category the resource should assigned to
SecurityLevel	Int32	Security level of the resource
SkillLevelMax	Int32	Maximum skill level of the resource
SkillLevelMin	Int32	Minimum skill level of the resource
EmailAddress	String	Email address of participant
Supervisor	Identity	Resource's supervisor id
LastModifiedUser	Identity	The last user to modify the resource
LastModifiedDate	DateTime	Date the resource was last modified
NTName	String	Resource's name in the Windows environment
GroupId	Identity	The group the resource is to be attached to
Supervisor	Identity	Resource's supervisor id
ExtensionFields	Collection	Collection of ExtensionFields for any additional information

Security: No restrictions apply.

CategoryIdentity GetWorkingCategory	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Retrieves the working category details of the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrieve the category for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes
Name	String	Name of the resource	Yes, if Id is not specified
Resource Type	Int16	The type of the resource	Yes, if Name is not specified

Returns

A CategoryIdentity that has the details of the resource's working category.

Name	Type	Comment
Id	String	Id of the category
Name	String	Name of the category

Security: No restrictions apply.

int GetWorkingDaysBetweenDatesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		DateTime	toDate,
		bool	useOnLoanGroupResourceId,
		ResourceIdentity	onLoanGroupResourceIdentity
	)

Retrieves the number of working days between two specified dates for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrieve the working days for. While creating this resource make sure that Working Group has been assigned.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate From Date. This must be specified.

toDate To Date. This must be specified.

useOnLoanGroupResourceId If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit

onLoanGroupResourceIdentity object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true.

Returns: The number of working days for the resource.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
If the system is not set to use the business calendar then the days returned will be simply the difference between the dates.

Making use of 'On Loan' resources: If useOnLoanGroupResourceId is set to true then the resource's calendar will be checked on a day by day basis.
If the resource is on loan that day, and the resource Id passed in matches the one the resource is on loan to, then the resource is considered to be on loan to you from somewhere else and will be counted as a credit.
If the resource Id passed in does not match then the resource is considered to be on loan from you to another group and will be counted as a debit.

Security: No restrictions apply.

int GetWorkingHoursBetweenDatesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		DateTime	toDate,
		bool	useOnLoanGroupResourceId,
		ResourceIdentity	onLoanGroupResourceIdentity
	)

Retrieves the number of working hours between two specified dates for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrieve the working hours for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate From Date. This must be specified.

toDate To Date. This must be specified.

useOnLoanGroupResourceId If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit

onLoanGroupResourceIdentity object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true.

Returns: The number of working hours for the resource.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
If the system is not set to use the business calendar then the hours returned will be simply the difference between the dates.

Making use of 'On Loan' resources
If useOnLoanGroupResourceId is set to true then the resource's calendar will be checked on a day by day basis.
If the resource is on loan that day, and the resource Id passed in matches the one the resource is on loan to, then the resource is considered to be on loan to you from somewhere else and will be counted as a credit.
If the resource Id passed in does not match then the resource is considered to be on loan from you to another group and will be counted as a debit.

Security: No restrictions apply.

TimePeriod GetWorkingHoursBreakdownForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		int	hours
	)

Converts the specified number of hours into a resource's working time.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id to retrieve the working hours breakdown.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

hours Number of working hours to breakdown.

Returns

A object of type TimePeriod, containing the working time in days, hours, hours and seconds.

Name	Type	Comment
Days	In16	The number of days the resource was on loan for.
Hours	In16	The number of hours the resource was on loan for.
Minutes	In16	The number of minutes the resource was on loan for.
Seconds	In16	The number of seconds the resource was on loan for.
FormattedAsString	String	The TimePeriod in string format.
TotalSeconds	In16	Always 0
TotalMinutes	In16	Always 0

Remarks: The parameter hours defaults to 0 if left blank.
If the system is not set to use the business calendar then the time period returned will be in standard 24 hour days.

Security: No restrictions apply.

int GetWorkingMinutesBetweenDatesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		DateTime	toDate,
		bool	useOnLoanGroupResourceId,
		ResourceIdentity	onLoanGroupResourceIdentity
	)

Retrieves the number of working minutes between two specified dates for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrieve the working hours for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate From Date. This must be specified.

toDate To Date. This must be specified.

useOnLoanGroupResourceId If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit

onLoanGroupResourceIdentity object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true.

Returns: The number of working minutes for the resource.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
If the system is not set to use the business calendar then the minutes returned will be simply the difference between the dates.

Making use of 'On Loan' resources
If useOnLoanGroupResourceId is set to true then the resource's calendar will be checked on a day by day basis.
If the resource is on loan that day, and the resource Id passed in matches the one the resource is on loan to, then the resource is considered to be on loan to you from somewhere else and will be counted as a credit.
If the resource Id passed in does not match then the resource is considered to be on loan from you to another group and will be counted as a debit.

Security: No restrictions apply.

TimePeriod GetWorkingMinutesBreakdownForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		int	minutes
	)

Converts the specified number of minutes into a resource's working time.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id to retrieve the working minutes breakdown.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

minutes Number of working minutes to breakdown.

Returns

A object of type TimePeriod, containing the working time in days, hours, minutes and seconds.

Name	Type	Comment
Days	In16	The number of days the resource was on loan for.
Hours	In16	The number of hours the resource was on loan for.
Minutes	In16	The number of minutes the resource was on loan for.
Seconds	In16	The number of seconds the resource was on loan for.
FormattedAsString	String	The TimePeriod in string format.
TotalSeconds	In16	Always 0
TotalMinutes	In16	Always 0

Remarks: The parameter minutes defaults to 0 if left blank.
If the system is not set to use the business calendar then the time period returned will be in standard 24 hour days.

Security: No restrictions apply.

int GetWorkingSecondsBetweenDatesForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	fromDate,
		DateTime	toDate,
		bool	useOnLoanGroupResourceId,
		ResourceIdentity	onLoanGroupResourceIdentity
	)

Retrieves the number of working seconds between two specified dates for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to retrieve the working hours for.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

fromDate From Date. This must be specified.

toDate To Date. This must be specified.

useOnLoanGroupResourceId If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit

onLoanGroupResourceIdentity object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true.

Returns: The number of working seconds for the resource.

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
If the system is not set to use the business calendar then the seconds returned will be simply the difference between the dates.

Making use of 'On Loan' resources
If useOnLoanGroupResourceId is set to true then the resource's calendar will be checked on a day by day basis.
If the resource is on loan that day, and the resource Id passed in matches the one the resource is on loan to, then the resource is considered to be on loan to you from somewhere else and will be counted as a credit.
If the resource Id passed in does not match then the resource is considered to be on loan from you to another group and will be counted as a debit.

Security: No restrictions apply.

TimePeriod GetWorkingSecondsBreakdownForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		int	seconds
	)

Converts the specified number of seconds into a resource's working time.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id to retrieve the working seconds breakdown.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

seconds Number of working seconds to breakdown.

Returns

A object of type TimePeriod, containing the working time in days, hours, minutes and seconds.

Name	Type	Comment
Days	In16	The number of days the resource was on loan for.
Hours	In16	The number of hours the resource was on loan for.
Minutes	In16	The number of minutes the resource was on loan for.
Seconds	In16	The number of seconds the resource was on loan for.
FormattedAsString	String	The TimePeriod in string format.
TotalSeconds	In16	Always 0
TotalMinutes	In16	Always 0

Remarks: The parameter seconds defaults to 0 if left blank.
If the system is not set to use the business calendar then the date returned will be in standard 24 hour days.

Security: No restrictions apply.

TimePeriod GetWorkingTimeBetweenDatesForResource	(	string	sessionId,
		ResourceTimeFilter	resourceTimeFilter
	)

Retrieves the working time between two specified dates for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceTimeFilter

A ResourceTimeFilter that specifies the resource and date details.

Name	Type	Comment	Required
ResourceIdentity	Identity	The details of the resource	Yes - Id or Name is required
FromDate	DateTime	The start date	Yes
ToDate	DateTime	The end date	Yes
OnLoanGroupeResouceIdentity	Identity	The details of the on loan group	Yes - if UseOnLoanGroupResourceId is set to `true`
UseOnLoanGroupResourceId	Boolean	Indicates that the loan group should be taken into account	No

Returns

A TimePeriod detailing the working time.

Name	Type	Comment
Days	In16	The number of days the resource was on loan for.
Hours	In16	The number of hours the resource was on loan for.
Minutes	In16	The number of minutes the resource was on loan for.
Seconds	In16	The number of seconds the resource was on loan for.
FormattedAsString	String	The TimePeriod in string format.
TotalSeconds	In16	Always 0
TotalMinutes	In16	Always 0

Remarks: The period defined by fromDate and toDate must be within 5 years of today's date whether in the past or the future.
If the system is not set to use the business calendar then the time returned will be simply the difference between the dates.

Making use of 'On Loan' resources
If useOnLoanGroupResourceId is set to true then the resource's calendar will be checked on a day by day basis.
If the resource is on loan that day, and the resource Id passed in matches the one the resource is on loan to, then the resource is considered to be on loan to you from somewhere else and will be counted as a credit.
If the resource Id passed in does not match then the resource is considered to be on loan from you to another group and will be counted as a debit.

Security: No restrictions apply.

bool IsExcludedFromManualWorkAllocation	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Determines whether the resource has been excluded from muanl work allocation using ExcludeFromManualWorkAllocation method.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity resource for which the check should be carried out.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: Returns true if the resource is exculded, falsde otherwise.

Security: No restrictions apply.

bool IsResourceInGroup	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ResourceIdentity	groupIdentity
	)

Determines whether the specified resource is in the specified group

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource to check whether the resource exists in the group or not.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

groupIdentity

A ResourceIdentity object containing the resource id information of the group resource to check whether the resource exists in group or not.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Returns: Returns true, if the specified resource is a member of specified group, false otherwise.

Security: No restrictions apply.

bool IsWorkingDateTimeForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	dateToCheck
	)

Determines whether the specified datetime is a working day for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource whose working day is to be checked.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

dateToCheck Date to check. Must be specified.

Returns: Returns true if dateToCheck falls within the resources working time, false otherwise.

Remarks: If the business calendar is not being used then the return value will always be false.

Security: No restrictions apply.

bool IsWorkingDayForResource	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		DateTime	dateToCheck
	)

Determines whether the specified date is a working day for the resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource to retrieve the working day.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

dateToCheck Date to be checked. Please note that any time part will be ignored. Must be specified.

Returns: Returns true if the resource is working at any point on the given day, false otherwise.

Remarks: If the business calendar is not being used then the return value will always be true.

Security: No restrictions apply.

LdapSynchonizationErrors ProcessLdapSynchronizationErrors	(	string	sessionId,
		LdapSynchronizationData	synchronizationData
	)

Processes the specified LDAP synchronization errors.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

synchronizationData

A LdapSynchronizationData object containing the LDAP synchronization data.

Name	Type	Comment	Required
ServerName	String	The name of the LDAP server	Yes
UserName	String	The username for that server	Yes
Password	String	The password for the user	Yes
ErrorXml	String	The password for the user	No
DefaultSecuityLevel	Int16	The default security level for user on the server	No
SetCategoryAccess	Boolean	Determines whether category access should be set for the user	No
DeactivateUser	Boolean	Indicates whether to deactivate the user or not. If set to yes, will deactivate the user when delete user fails. Will set the user end date to current date -1 so that user can no longer login.	No

Returns

An instance of type LdapSynchonizationErrors that has details of the processed errors.

Name	Type	Comment
Successful	Boolean	Indicates whether the method worked correctly
CriticalError	Boolean	Indicates that any failure is critical
ErrorXml	Boolean	The error text returned by the LDAP server

This will usually process the ErrorXML return value from SynchronizeWithLdap.

Security: Resource must have at least Read Write access permission on Resource ACL.

void RemoveExclusionFromManualWorkAllocation	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Allow resource to be available for manual work allocation.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object for the resource to be used.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Remarks: An exclusion is added using ExcludeFromManualWorkAllocation.

Security: No restrictions apply.

void RemoveResourceFromGroup	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ResourceIdentity	groupIdentity
	)

Removes the specified resource from the specified group.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to be removed.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

groupIdentity

A ResourceIdentity object specifying the group the resource is to be removed from.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Security: Resource must have at least Read Write access permission on Resource ACL.

bool RemoveSkillLevelForResourceAndProcess	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ProcessIdentity	processIdentity,
		string	comments
	)

Removes the existing skill level for a specified resource for a specified process

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object containing the resource id information of the resource to remove the skill level.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

processIdentity

A ProcessIdentity object containing the process id information to remove the skill level.

Name	Type	Comment	Required
Id	String	Id of the process	Yes - if Name is not specified
Version	Double	Use to indicate a specific version	No
Name	String	Name of the process	Yes - if Id is not specified

comments A string for comments that will be added to the audit log, if it is enabled

Returns: True if existing skill level is removed; false otherwise

Remarks: Resource process skill levels can be added within the TotalAgility Workspace or by ApplySkillLevelToResourceAndProcess.

Security: No restrictions apply.

void RemoveSubordinatesExclusionFromManualWorkAllocation	(	string	sessionId,
		ResourceIdentity	resourceIdentity
	)

Removes exclusion from manual work allocation for each resource that is a subordinate of the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object that specifies the resource to check for subordinates.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Security: No restrictions apply.

void RemoveWorkAllocationRuleFromGroup	(	string	sessionId,
		ResourceIdentity	groupIdentity,
		WorkAllocationRuleIdentity	ruleIdentity
	)

Removes the specified work allocation rule from the specified group.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

groupIdentity

A ResourceIdentity object containing the details of the group resource to remove the work allocation rule from.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

ruleIdentity

A WorkAllocationRuleIdentity object containing the rule id information of the work allocation rule that needs to be removed.

Name	Type	Comment	Required
Id	String	The Id of the work allocation rule	Yes - if Name is not specified
Name	String	The name of the work allocation rule	Yes - if Id is not specified

Remarks: Work alloction rules are assigned to a group using AssignWorkAllocationRuleToGroup.

Security: No restrictions apply.

LdapSynchronizationResult SynchronizeWithLdap	(	string	sessionId,
		LdapSynchronizationSettings	settings
	)

Synchronizes the with an LDAP Server in order to retrieve a list of users which will be added to the resources available within TotalAgility.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

settings

A LdapSynchronizationSettings object containing the LDAP synchronization settings.

Name	Type	Comment	Required
ServerName	String	The name of the LDAP server.	Yes
ResourceName	String	Specific group level to synchronize at.	No
UserName	String	Login name for the LDAP server.	Yes
Password	String	Password for the login user.	Yes
LastSequenceChangeNumber	String	Keeps track of when the LDAP directory last changed.	No
ReferralChase	Boolean	Indicates whether LDAP referrals should be followed.	No
DefaultSecurityLevel	Int16	Default security level assigned to added resources.	No
SetCategoryAccessLists	Boolean	NOT used.	No
DeactivateUser	Boolean	Indicates whether to deactivate the user or not. If set to yes, will deactivate the user when delete user fails. Will set the user end date to current date -1 so that user can no longer login.	No

Returns

An instance of type LdapSynchronizationResult that holds success and failure information

Name	Type	Comment
LastSequenceChangeNumber	String	Used to keep track of changes in the LDAP server.
Successful	Boolean	Indicates whether the method worked correctly
ErrorXml	String	The error text returned by the LDAP server
CriticalError	Boolean	Indicates that any failure is critical
CriticalErrorText	String	Critical error message

Remarks: A system map for Active Directory synchronization is included in TotalAgility by default. Please see here for more details.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UnDelegate	(	string	sessionId,
		ResourceIdentity	delegator
	)

Removes any delegation from the specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

delegator

A ResourceIdentity object specifying resource that is delgating tasks to another resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Remarks: Dlegations can be set up within the totalAgility Workspace or via the DelegateFromTo method.

Security: No restrictions apply.

void UpdateCaseParticipant	(	string	sessionId,
		WorkerResource	resource
	)

Please note that this function is deprecated. Please use UpdateCaseParticipant2 instead.
Updates the details for for specified case participant.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource object containing the resource information of the worker resource to update the information.

Name	Type	Comment	Required
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Id or Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	No
SkillLevelMax	Int32	Maximum skill level of the resource	No
SkillLevelMin	Int32	Minimum skill level of the resource	No
EmailAddress	String	Email address of participant	Yes
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified - must be between 01-Jan-1753 and 31-Dec-9999	See Remarks below
NTName	String	Resource's name in the Windows environment	No
GroupId	Identity	The group the resource is to be attached to	No
Supervisor	Identity	Resource's supervisor id	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional informatio	No

Remarks: LastModifiedDate match the LastModifedDate stored on the database for the CaseParticipant

Security: No restrictions apply.

void UpdateCaseParticipant2	(	string	sessionId,
		UpdatedCaseParticipant	resource,
		bool	overwrite
	)

Updates the case participants for a specified resource.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A UpdatedCaseParticipant object deriving from the CaseParticipant2 class containing the resource information of the worker resource to update the information.

Name	Type	Comment	Required
Identity	Identity	The persona identity.	No
PasswordChanged	Boolean	Indicates whether the password has changed	No
PersonaIdentity	Identity	Details of the resource's persona	No
LastModifiedDate	DateTime	Date the resource is valid from	No
Name	String	Name of participant	Yes
Category	Identity	The category to be assigned to the resource	Yes - Id or Name is required
EmailAddress	String	Email address of participant	Yes
Password	String	Participant's password	No
StartDate	DateTime?	Date the resource is valid from	No
EndDate	DateTime?	Date the resource is valid to	No

overwrite if set to true [overwrite].

Remarks: The case participant’s minimum skill level, security level, resource name, managerial name etc will be updated.

Security: No restrictions apply.

void UpdateDelegation	(	string	sessionId,
		DelegateInfo	delegateInfo,
		bool	overwrite
	)

Updates the specified delegation and optionally overwrites it

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

delegateInfo

A DelegateInfo object containing the delegate information to update the delegation details.

Name	Type	Comment	Required
Delegator	Identity	Resource details of the delegator	Yes - Id or Name is required
Delegatee	Identity	Resource details of the delegatee	Yes - Id or Name is required
CreatedBy	Identity	The resource that created the delegation	No
LastModifiedBy	Identity	The last resource to modify the delegation	Yes - Id or Name is required
CreationDate	DateTime?	The date of creation	No
LastModifiedDate	DateTime?	The date the delegation was last modified	No
EndDate	DateTime?	The date the delegation will end	No
OverWrite	Boolean	Indicates whether an existing delegation should be replaced	No

overwrite Set to true to replace a delegation.

Remarks: UpdateDelegation wiil only work when the Delegator has an existing delegation.
Setting OverWrite to false means that the method will always fail.
Existing details will be overwritten when the method executes successfully.

Security: No restrictions apply.

void UpdateExternalWorkerGroupResource	(	string	sessionId,
		WorkerGroupResource	resource,
		bool	overwrite
	)

This method is deprecated. Please use UpdateCaseParticipant2 instead

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
resource	A Model.Resources.WorkerGroupResource object specifying the worker group and the details to update.
overwrite	True, to overwrite; false, otherwise.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateNotesStatus	(	string	sessionId,
		NoteIdentityCollection	noteIdCollection,
		short	status
	)

Updates the status of all the specified notes to either read or unread.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

noteIdCollection

A Collection of type NoteIdentity. At least one must be specified..

Name	Type	Comment	Required
Id	String	The Id of the note to update.	Yes

status

The status that the specified notes will be set to. Valid values are:

1 - Unread
2 - Read any other values will cause an error.

Security: No restrictions apply.

void UpdateResourceSupervisor	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ResourceIdentity	supervisorIdentity
	)

Assigns a supervisor to the specified resource, replacing any existing supervisor.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to update.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

supervisorIdentity

A ResourceIdentity object containing the details of the supervisor.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateResourceWorkingGroup	(	string	sessionId,
		ResourceIdentity	resourceIdentity,
		ResourceIdentity	workingGroup
	)

Assigns the specified working group to the specified respurce, replacing any existing working group.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resourceIdentity

A ResourceIdentity object specifying the resource to update.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

workingGroup

A ResourceIdentity object specifying the working group to be assigned to the resource.

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Not used	No

Remarks: Setting resourceIdentity to a group will not cause a failure but nothing will actually be done.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateWorkerGroupResource	(	string	sessionId,
		WorkerGroupResource	resource,
		bool	overwrite
	)

Please note that this function is deprecated. Please use UpdateWorkerGroupResource2 instead.
Updates the worker group resource information, optionally replacing any existing information.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerGroupResource object containing the worker group resource information that needs to be updated.

Name	Type	Comment	Required
AssoicatedResources	Collection	Not used. Please see AddWorkerGroupResourceMember to add members to the group.	No
WorkAllocationRule	Identity	Specify a Work Allocation Rule to associate with the group.	No
Identity	Identity	The name of the group to be updated.	Yes - Id or Name is required
Category	Identity	The category that the group belongs to.	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource.	Yes
SkillLevelMax	Int32	Maximum skill level of the resource.	Yes
SkillLevelMin	Int32	Minimum skill level of the resource.	Yes
EmailAddress	String	Email address of participant.	No
Supervisor	Identity	Details of the resource's supervisor.	No
LastModifiedUser	Identity	The last user to modify the resource.	No
LastModifiedDate	DateTime	Date the resource was last modified - must be between 01-Jan-1753 and 31-Dec-9999	See Remarks below
NTName	String	Resource's name in the Windows environment.	No
GroupId	Identity	The group the resource is to be attached to.	No
Supervisor	Identity	Resource's supervisor id.	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information.	No

overwrite Indicates whether the group should be updated regardless od any other changes that may happened. Defaults to false

Remarks: If overwrite is set to false then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateWorkerGroupResource2	(	string	sessionId,
		WorkerGroupResource2	resource,
		bool	overwrite
	)

Updates the worker group resource information, optionally replacing any existing information.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerGroupResource2 object containing the worker group resource information that needs to be updated.

Name	Type	Comment	Required
WorkAllocationRule	Identity	Specify a Work Allocation Rule to associate with the group.	No
Identity	Identity	The name of the group to be updated.	Yes - Id or Name is required
Category	Identity	The category that the group belongs to.	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource.	Yes
SkillLevelMax	Int32	Maximum skill level of the resource.	Yes
SkillLevelMin	Int32	Minimum skill level of the resource.	Yes
EmailAddress	String	Email address of participant.	No
Supervisor	Identity	Details of the resource's supervisor.	No
LastModifiedUser	Identity	The last user to modify the resource.	No
LastModifiedDate	DateTime	Date the resource was last modified - must be between 01-Jan-1753 and 31-Dec-9999	See Remarks below
NTName	String	Resource's name in the Windows environment.	No
GroupId	Identity	The group the resource is to be attached to.	No
Supervisor	Identity	Resource's supervisor id.	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information.	No

overwrite Indicates whether the group should be updated regardless of any other changes that may happened. Defaults to false

Remarks: If overwrite is set to false then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateWorkerGroupResource3	(	string	sessionId,
		WorkerGroupResource2	resource,
		ResourceIdentityCollection	addMembers,
		ResourceIdentityCollection	removeMembers,
		bool	overwrite
	)

Updates the worker group resource information using the addMember and removeMembers parameters.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerGroupResource2 object containing the worker group resource information that needs to be updated.

Name	Type	Comment	Required
WorkAllocationRule	Identity	Specify a Work Allocation Rule to associate with the group.	No
Identity	Identity	The name of the group to be updated.	Yes - Id or Name is required
Category	Identity	The category that the group belongs to.	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource.	Yes
SkillLevelMax	Int32	Maximum skill level of the resource.	Yes
SkillLevelMin	Int32	Minimum skill level of the resource.	Yes
EmailAddress	String	Email address of participant.	No
Supervisor	Identity	Details of the resource's supervisor.	No
LastModifiedUser	Identity	The last user to modify the resource.	No
LastModifiedDate	DateTime	Date the resource was last modified - must be between 01-Jan-1753 and 31-Dec-9999	See Remarks below
NTName	String	Resource's name in the Windows environment.	No
GroupId	Identity	The group the resource is to be attached to.	No
Supervisor	Identity	Resource's supervisor id.	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information.	No

addMembers

A collection of type ResourceIdentity that indicate what members are to be added to the group resource

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Type of the resource group or worker resource.	Yes - Its assumed that resource type is valid to avoid multiple database hits.

removeMembers

A collection of type ResourceIdentity that indicate what members sre to be removed from the group resource

Name	Type	Comment	Required
Id	String	Id of the resource	Yes - if Name is not specified
Name	String	Name of the resource	Yes - if Id is not specified
Resource Type	Int16	Type of the resource group or worker resource.	Yes - Resource type should be valid

overwrite Indicates whether the group should be updated regardless of any other changes that may happened. Defaults to false

Remarks: If overwrite is set to false then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateWorkerResource	(	string	sessionId,
		WorkerResource	resource,
		bool	overwrite
	)

This function is deprecated. Please use UpdateWorkerResource2 instead.
Updates the worker resource information with the specified information.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource object containing the worker resource information that needs to be updated.

Name	Type	Comment	Required
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be added	Yes - Id or Name is required
Category	Identity	Category the resource should assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	No
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	No
NTName	String	Resource's name in the Windows environment	No
GroupId	Identity	The group the resource is to be attached to	No
Supervisor	Identity	Resource's supervisor id	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

overwrite True to overwrite; false otherwise.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateWorkerResource2	(	string	sessionId,
		WorkerResource2	resource,
		bool	overwrite
	)

Updates a resource based on the specified details.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource2 object containing the details of the resource particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Details of the resource's persona	No
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be updated	Yes - Name is required. Id is required also, if updating the resource name
Category	Identity	Category the resource should be assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	No
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	see Remarks below
NTName	String	Resource's name in the Windows environment	Yes - If Resource Type is set to Worker or ExternalUser
Resource Type	Int16	Type of the resource	No
GroupId	Identity	The group the resource is to be attached to	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

overwrite Indicates whether the resource should be updated regardless of any other changes that may happened. Defaults to false

Remarks: If overwrite is set to false then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database.

Security: Resource must have at least Read Write access permission on Resource ACL.

void UpdateWorkerResource3	(	string	sessionId,
		WorkerResource2	resource,
		ResourceIdentityCollection	addToGroups,
		ResourceIdentityCollection	removeFromGroups,
		bool	overwrite
	)

Updates a resource based on the specified details.

Parameters

sessionId A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.

resource

A WorkerResource2 object containing the details of the resource particpant to add.

Name	Type	Comment	Required
PersonaIdentity	Identity	Details of the resource's persona	No
FixedCostRate	Double	Fixed cost of the resource	No
VariableCostRate	Double	Variable cost of the resource	No
VariableCostPeriod	Double	Unit of time for variable costs	No
WorkingCategory	Identity	Category that the resource will be working in	No
Password	String	Resource's password	No
ManagerialLevel	Int16	Managerial level of the resource	No
WorkingGroup	Identity	Group the resource will be working in	No
StartDate	DateTime	Date the resource is valid from	No
EndDate	DateTime	Date the resource is valid to	No
PasswordChanged	Boolean	Indicates that the password has changed	No
Identity	Identity	Object containing the name of the resource to be updated	Yes - Name is required. Id is required also, if updating the resource name
Category	Identity	Category the resource should be assigned to	Yes - Id or Name is required
SecurityLevel	Int32	Security level of the resource	Yes
SkillLevelMax	Int32	Maximum skill level of the resource	Yes
SkillLevelMin	Int32	Minimum skill level of the resource	Yes
EmailAddress	String	Email address of participant	No
Supervisor	Identity	Resource's supervisor id	No
LastModifiedUser	Identity	The last user to modify the resource	No
LastModifiedDate	DateTime	Date the resource was last modified	see Remarks below
NTName	String	Resource's name in the Windows environment	Yes - If Resource Type is set to Worker or ExternalUser
Resource Type	Int16	Type of the resource	No
GroupId	Identity	The group the resource is to be attached to	No
ExtensionFields	Collection	Collection of ExtensionFields for any additional information	No

addToGroups A collection that indicates groups the resource is to be added to

removeFromGroups A collection that indicates groups the resource is to be removed from

overwrite Indicates whether the resource should be updated regardless of any other changes that may happened. Defaults to false

Remarks: If overwrite is set to false then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database.

Security: Resource must have at least Read Write access permission on Resource ACL.

Public Member Functions

Description

Member Functions