Add or Update a Web User

Add or update a web user, by email address.

Query String Parameters

Name	Type	Description	Required
Action	String	WebUserSave	Required
WebUserName	String	User name.	Required
WebUserEmail	String	User email.	Required
WebUserPwd	String	User password.	Required
UserMobile	String	User mobile number.	Optional
Position	String	User position.	Optional
UserIPRestriction	String	IP restriction.	Optional
JobCategoryId	Int	If you require your user to be in a certain group, you can use the Id of the group from the Job Group page to set the default job category.	Optional
JobCategoryDescription	String	If you require your user to be in a certain group, you can take the name of the group from the Job Group page to set the default job category.	Optional
UserType	Int	User license type	Optional
UserGroupDescription	String	If you require your user to be in a certain group, you can input the name of the group from the User Group page, Into this parameter to set the user group	Optional
UserGroupId	Int	If you require your user to be in a certain group, you can take the Id of the group from the User Group page Into this parameter to set the user group	Optional
UserRoleId	Int	If you require your user to have a certain role, you can request Ids from BigChange that you can use to set the user role.	Optional
UserRoleDescription	String	If you’d prefer, you can use the name of the role instead, to set the user role.	Optional
cust_custom field name	String(500)	Pass cust_ followed by the caption of an existing custom field.	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	WebUserName parameter required	Mandatory parameter was not supplied
2	WebUserEmail parameter required	Mandatory parameter was not supplied
2	WebUserPwd parameter required	Mandatory parameter was not supplied
2	Sorry, '{pwdString}' is a word too simple to be used as a password	Password is considered weak. Please use a stronger password
2	User Mobile should be 20 characters or less	Phone Number is too long
2	Invalid parameter format - UserMobile	Phone numbers must be encoded and in International format with no spaces. ie: %2B447954012012
2	Invalid parameter - UserType	Integer value is invalid or was not specified (when required)
2	Invalid parameter - UserGroupId	Integer value is invalid or was not specified (when required)
2	Cannot find User Group	No record found using the specified parameters
2	Invalid parameter - JobCategoryId	Integer value is invalid or was not specified (when required)
2	Cannot find Job Category	No record found using the specified parameters
2	You must be an admin to set User Role	Admin permissions are required to set this role
2	Invalid Parameter - UserRoleId	Integer value is invalid or was not specified (when required)
2	Cannot find User Role	No record found using the specified parameters
2	WebUserSave is not implemented for Auth0 enabled customers via the user management service

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=WebUserSave&WebUserName=New User&WebuserEmail=newuser@email.com&WebUserPwd=Password123&UserType=1&UserRoleId=1234

Response

Response Data

{
  "Code": 0,
  "Result": {
    "UserId": 21821
  }
}