Inherited by DCTTPIEngine.WCFInterface.WCFService.

Public Member Functions
Stream	AssignExternalUserToApplicationRest (string authenticationToken, string applicationName, string externalUserIdentifier, int userId, bool useApplicationSettings=false)
	Assign a specific user linked to an external user so that pass through authentication will happen with Online. ie User logs in at Discovery and want to see his trips, he passes via the Discovery website to Online without the need to authenticate again. More...

Stream	AssignUserReportProfileRest (string authenticationToken, int userId, string reportProfile)
	Assign a report profile to a user. More...

Stream	AssignUserRightTemplateRest (string authenticationToken, int userGroupId, string userRightTemplateName)
	Obtain the User Right Template from the parameter and assign it to the relevant User Group in the Cost Centre. More...

Stream	AssignUserRightTemplateToUserRest (string authenticationToken, int userId, string userRightTemplateName)
	Obtain the User Right Template from the parameter and assign it to the relevant single Users. More...

Stream	AssignUserRest (string authenticationToken, int userId, int userGroupId)
	Assign the User to the UserGroup More...

Stream	ChangeUserPasswordRest (string authenticationToken, int userId, string newPassword, string oldPassword)
	ChangeUserPassword will update a valid user's password. More...

Stream	CreateUserRest (string authenticationToken, string userName, string fullName, string password, int costCentreId, int userGroupId, int timeZoneDetailId, decimal defaultLatitude, decimal defaultLongitude, bool isMetric=true)
	Create the user, providing relevant details. This user will be assigned to the UserGroup More...

Stream	CreateUserGroupRest (string authenticationToken, int costCentreId, string userGroupName, string userGroupDescription)
	CreateUserGroup created the UserGroup in the provided Cost Centre and assign the calling user to the User Group. Returns the created UserGroup object. More...

Stream	GetNodePropertyValueForUserRest (string authenticationToken, int userId, int propertyId)
	Get a specific node property of the supplied User. More...

Stream	GetUserRest (string authenticationToken, string userName)
	Get the relevant User based on the UserName More...

Stream	GetUserGroupRest (string authenticationToken, int costCentreId, string userGroupName)
	GetUserGroup returns the requested UserGroup object from a UserGroup name and the Cost Centre. More...

Stream	GetUsersRest (string authenticationToken, int userGroupId)
	Get all users assigned to a specific user group More...

Stream	RemoveUserRest (string authenticationToken, int userId, int userGroupId, bool deleteUser=false)
	Remove the User from the UserGroup. If not beloning to any UserGroup, delete the user. If RemoveAll is true, User will be deleted. More...

Stream	SetNodePropertyValueForUserRest (string authenticationToken, int userId, NodePropertyValue nodePropertyValue)
	Set a specific node property. This is for the ad-hoc single setting that needs to be changed. More...

Member Function Documentation

§ AssignExternalUserToApplicationRest()

Stream DCTTPIEngine.WCFInterface.IUser.AssignExternalUserToApplicationRest	(	string	authenticationToken,
		string	applicationName,
		string	externalUserIdentifier,
		int	userId,
		bool	useApplicationSettings = `false`
	)

Assign a specific user linked to an external user so that pass through authentication will happen with Online. ie User logs in at Discovery and want to see his trips, he passes via the Discovery website to Online without the need to authenticate again.

Parameters

authenticationDetails	The AuthenticationDetails object from the signed-in user
applicationName	The application of which the user must be linked to
externalUserIdentifier	External User name that will be passed to the URL, so this will map back to the internal userId associated with this external user
user	The internal user object
useApplicationSettings	If true, apply the default long/lat, time zone, report profile of the application to the user as well

Returns: The result of the ErrorCode from assigning the application.

§ AssignUserReportProfileRest()

Stream DCTTPIEngine.WCFInterface.IUser.AssignUserReportProfileRest	(	string	authenticationToken,
		int	userId,
		string	reportProfile
	)

Assign a report profile to a user.

Parameters

authenticationDetails
user
reportProfile

Returns: ErrorCode

§ AssignUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.AssignUserRest	(	string	authenticationToken,
		int	userId,
		int	userGroupId
	)

Assign the User to the UserGroup

Parameters

authenticationDetails
userName

Returns: Result or the error

§ AssignUserRightTemplateRest()

Stream DCTTPIEngine.WCFInterface.IUser.AssignUserRightTemplateRest	(	string	authenticationToken,
		int	userGroupId,
		string	userRightTemplateName
	)

Obtain the User Right Template from the parameter and assign it to the relevant User Group in the Cost Centre.

Parameters

authenticationDetails
userGroup
userRightTemplateName

Returns
True/False, depending on success

§ AssignUserRightTemplateToUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.AssignUserRightTemplateToUserRest	(	string	authenticationToken,
		int	userId,
		string	userRightTemplateName
	)

Obtain the User Right Template from the parameter and assign it to the relevant single Users.

Parameters

authenticationDetails
userGroup
userRightTemplateName

Returns: True/False, depending on success

§ ChangeUserPasswordRest()

Stream DCTTPIEngine.WCFInterface.IUser.ChangeUserPasswordRest	(	string	authenticationToken,
		int	userId,
		string	newPassword,
		string	oldPassword
	)

ChangeUserPassword will update a valid user's password.

Parameters

authenticationDetails	AuthenticationDetails object created when calling Login Method.
user	The User that password will change.
newPassword	New Password, unencrypted.
oldPassword	Old Password, unencrypted.

Returns

§ CreateUserGroupRest()

Stream DCTTPIEngine.WCFInterface.IUser.CreateUserGroupRest	(	string	authenticationToken,
		int	costCentreId,
		string	userGroupName,
		string	userGroupDescription
	)

CreateUserGroup created the UserGroup in the provided Cost Centre and assign the calling user to the User Group. Returns the created UserGroup object.

Parameters

authenticationDetails
userGroupName
userGroupDescription

Returns: UserGroup

§ CreateUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.CreateUserRest	(	string	authenticationToken,
		string	userName,
		string	fullName,
		string	password,
		int	costCentreId,
		int	userGroupId,
		int	timeZoneDetailId,
		decimal	defaultLatitude,
		decimal	defaultLongitude,
		bool	isMetric = `true`
	)

Create the user, providing relevant details. This user will be assigned to the UserGroup

Parameters

authenticationDetails
userName
fullName
password
costCentreDetails
userGroup
timeZoneDetail
defaultLatitude
defaultLongitude
isMetric

Returns: The created User

§ GetNodePropertyValueForUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.GetNodePropertyValueForUserRest	(	string	authenticationToken,
		int	userId,
		int	propertyId
	)

Get a specific node property of the supplied User.

Parameters

authenticationDetails	AuthenticationDetails object created when calling Login Method
user	The internal user object
propertyId	Id of the property, an identifier.

Returns: NodePropertyValue of the requested property.

§ GetUserGroupRest()

Stream DCTTPIEngine.WCFInterface.IUser.GetUserGroupRest	(	string	authenticationToken,
		int	costCentreId,
		string	userGroupName
	)

GetUserGroup returns the requested UserGroup object from a UserGroup name and the Cost Centre.

Parameters

authenticationDetails
userGroupName

Returns: UserGroup

§ GetUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.GetUserRest	(	string	authenticationToken,
		string	userName
	)

Get the relevant User based on the UserName

Parameters

authenticationDetails
userName

Returns
The sought after User

§ GetUsersRest()

Stream DCTTPIEngine.WCFInterface.IUser.GetUsersRest	(	string	authenticationToken,
		int	userGroupId
	)

Get all users assigned to a specific user group

Parameters

authenticationDetails
userGroup

Returns
returns a Users object

§ RemoveUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.RemoveUserRest	(	string	authenticationToken,
		int	userId,
		int	userGroupId,
		bool	deleteUser = `false`
	)

Remove the User from the UserGroup. If not beloning to any UserGroup, delete the user. If RemoveAll is true, User will be deleted.

Parameters

authenticationDetails
user	The User to remove
userGroup	The UserGroup to remove the User from. If RemoveAll is true, not needed to provide the UserGroup
deleteUser

Returns

§ SetNodePropertyValueForUserRest()

Stream DCTTPIEngine.WCFInterface.IUser.SetNodePropertyValueForUserRest	(	string	authenticationToken,
		int	userId,
		NodePropertyValue	nodePropertyValue
	)

Set a specific node property. This is for the ad-hoc single setting that needs to be changed.

Parameters

authenticationDetails	AuthenticationDetails object created when calling Login Method
NodePropertyValue	NodePropertyValue object that needs to be populated with PropertyId and PropetyValue.

Returns: ErrorCode of the method.

The documentation for this interface was generated from the following file:

UserService.cs

Public Member Functions

Member Function Documentation

§ AssignExternalUserToApplicationRest()

§ AssignUserReportProfileRest()

§ AssignUserRest()

§ AssignUserRightTemplateRest()

§ AssignUserRightTemplateToUserRest()

§ ChangeUserPasswordRest()

§ CreateUserGroupRest()

§ CreateUserRest()

§ GetNodePropertyValueForUserRest()

§ GetUserGroupRest()

§ GetUserRest()

§ GetUsersRest()

§ RemoveUserRest()

§ SetNodePropertyValueForUserRest()