PmlUser.asmx

Methods:

CreateUser
Create PML user only.

public string CreateUser(string sTicket, string xmlDoc)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

xmlDoc - XML document containing the new user's information

Return Value
XML Result - The result indicating the success of the operation or a list of errors
The XML result has following format for a successful result:
```
        <result status="OK"/>
      
```
The XML result has the following format for an unsuccessful result:
```
	<result status="Error">
	   <error>Missing required fields: First Name, Last Name</error>
	   <error>Invalid Email format</error>
	   ...
	</result>
```
Remark

sTicket must contain authentication of user with the Administrator role or permission to administrate PML users to perform this action.

PML Supervisors will only be able to input data into the following fields (any other requested fields will be ignored):

- FirstName
- LastName
- Phone
- Fax
- Email
- Login
- Password
- PasswordExpirationOption
- ExpirePasswordsEveryXDays
- IsLoanOfficer
- IsBrokerProcessor
- LoanAccessLevel
- BrokerProcessor
- CellPhone
- Pager

Example
UpdateUser
Update PML user only.

public string UpdateUser(string sTicket, string xmlDoc, string userName)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

xmlDoc - XML document containing the information to update

userName - Login name of PML account being updated

Return Value
XML Result - The result indicating the success of the operation or a list of errors
The XML result has following format for a successful result:
```
        <result status="OK"/>
      
```
The XML result has the following format for an unsuccessful result:
```
	<result status="Error">
	   <error>Branch not found</error>
	   <error>Invalid Email format</error>
	   ...
	</result>
```
Remark

sTicket must contain authentication of user with the Administrator role or permission to administrate PML users to perform this action.

PML Supervisors will only be able to update the following fields for users that they supervise (any other requested fields will be ignored):

- FirstName
- LastName
- Phone
- Fax
- Email
- Login
- IsActive
- Password
- PasswordExpirationOption
- ExpirePasswordsEveryXDays
- IsLoanOfficer
- IsBrokerProcessor
- LoanAccessLevel
- BrokerProcessor
- CellPhone
- Pager

Example

ChangePassword

Change PML user's password

public string ChangePassword(string sTicket, string newPassword)

Parameters

sTicket - Authentication string returned by AuthService.asmx.

newPassword - The new password the user's password will be changed to

Return Value

XML Result - The result indicating the success of the operation or a list of errors

The XML result has following format for a successful result:

        <result status="OK"/>

The XML result has the following format for an unsuccessful result:

	<result status="Error">
	   <error>Password must contain at least 1 number and 1 letter</error>
	</result>

Remark

This will work for any user. It will only let the user change their own password. It will continue to run even if the sTicket fails to authenticate due to an expired password.

Example

      string userName = "user";
      string password = "password";
      string newPassword = "newPassword";
      string customerCode="pmlxxxx";
      
      AuthService authService = new AuthService();
      string sTicket = authService.GetPmlUserAuthTicket(userName, password, customerCode);
      
      PmlUser pmlUser = new PmlUser();
      string xmlResult = pmlUser.ChangePassword(sTicket, newPassword);

ChangePasswordWithoutAuthTicket
Change PML user's password without requiring an auth ticket. The purpose of this function is to allow users whose passwords have expired to change their password.

public string ChangePasswordWithoutAuthTicket(string customerCode, string userName, string oldPassword, string newPassword)
Parameters

customerCode - The client code number assigned to you in our system. Your PML Support Engineer can provide you with your company's customer code if you do not know what it is. The format for this customer code is PML#### (i.e., PML0445)

userName - Login name of PML account being updated

oldPassword - Existing password for the PML account being updated

newPassword - New password for this PML account

Return Value
XML Result - The result indicating the success of the operation or a list of errors
The XML result has following format for a successful result:
```
        <result status="OK"/>
      
```
The XML result has the following format for an unsuccessful result:
```
	<result status="Error">
	   <error>Password must contain at least 1 number and 1 letter</error>
	</result>
```
Remark

This function will only let the user change their own password.

Example
```
      string customerCode = "pmlxxxx";
      string userName = "user";
      string oldPassword = "password";
      string newPassword = "newPassword";
      
      PmlUser pmlUser = new PmlUser();
      string xmlResult = pmlUser.ChangePasswordWithoutAuthTicket(customerCode, userName, oldPassword, newPassword);
     
      
```
ExportContactInformationOfAllPmlUsers
Export contact information of all PML users.

public string ExportContactInformationOfAllPmlUsers(string sTicket)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

Return Value

The string containing the comma separated value (CSV) list of the contact information for all PML users.

Remark

sTicket must contain authentication of user with the Administrator role or permission to administrate PML users to perform this action.

Example
```
      string userName = "user";
      string password = "password";
      
      AuthService authService = new AuthService();
      string sTicket = authService.GetUserAuthTicket(userName, password);
      
      PmlUser pmlUser = new PmlUser();
      string csvResult = pmlUser.ExportContactInformationOfAllPmlUsers(sTicket);
     
      
```
ExportPMLUserInformation
Export contact information of the requested PML user.

public string ExportPMLUserInformation(string sTicket, string pmlUserLoginName)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

pmlUserLoginName - the login name of the PML user to obtain information for.

Return Value

The string containing the comma separated value (CSV) list of the contact information for the requested PML user.

Remark

sTicket must contain authentication of user with the Administrator role or permission to administrate PML users to perform this action.

Example
```
      string userName = "user";
      string password = "password";
      
      AuthService authService = new AuthService();
      string sTicket = authService.GetUserAuthTicket(userName, password);
      string pmlUserLoginName = "loginName";
      
      PmlUser pmlUser = new PmlUser();
      string csvResult = pmlUser.ExportPMLUserInformation(sTicket, pmlUserLoginName);
     
      
```
ExportRelationshipInformationOfPmlUser
Export contact information for the given PML user's Lender Account Executive, Lock Desk, Manager, Underwriter, Processor, and Broker Processor

public string ExportRelationshipInformationOfPmlUser(string sTicket, string userName)
Parameters

sTicket - Authentication string returned by AuthService.asmx.

userName - Login name of the PML account to retrieve relationship information of.

Return Value

The string containing the comma separated value (CSV) list of the contact information for the given PML user's relationships.

Remark

sTicket must contain authentication of user with the Administrator role or permission to administrate PML users to perform this action.

Example
```
      string userName = "user";
      string password = "password";
      
      AuthService authService = new AuthService();
      string sTicket = authService.GetUserAuthTicket(userName, password);
      
      PmlUser pmlUser = new PmlUser();
      string csvResult = pmlUser.ExportRelationshipInformationOfPmlUser(sTicket, "PMLUserName");
     
      
```