Version: Next

importUser

This method allows adding/editing:

General user data;
Relationship between Department/Position/Team/Access group;
Relationship between user and domain controller.

If the user already exists - existing user ID -, the information will be edited and replaced for the information present in the request.

If a value of '1' is entered in the UpdateType attribute, the attributes of the list type will be replaced by the ones in the request; if no value or 0 is entered, the values will be added to those already recorded in the system.

To insert each of these items, it is necessary to follow the standard documented below.

Java class
Request	web/wwwroot/ws/java/administration/importUserRequestType.java
Return	web/wwwroot/ws/java/administration/importUserResponseType.java

Request:

ID	Required	Description
UserId	X	User's ID.
UserName	X	User's name.
UserLogin	X	Name the user inserts to log in to the system.
UserPassword	X	User's password.
UserCounterSign		User's countersign.
UserLanguage		Enter the user's language code, in accordance with the "Database Encoding" column of the Localization section, in the System Requirements document.
IsActive		Enabled user (1 - Enabled, 0 - Disabled).
IsEnabled		Blocked user (1 - Blocked, 0 - Unblocked).
NumMaxConnections		Maximum number of simultaneous user connections.
UserPhone		User's phone #.
UserEmail	X	User's e-mail address.
LeaderId		Leader's ID #.
UserPhoto		User's image in binary format 64.
UserDomainId	X¹	User's unique ID # in the domain controller.
DomainId	X²	ID # of the AD domain registered in SoftExpert Suite and to which the user is linked. (Used when synchronizing user data with Domain controller).
AccGroupIdArray		List of access group identifiers, separated by commas if you wish to add more than one.
RolPosIdArray		List of department and position identifiers. Each item representing a department and position must be specified as: area-identifier#department-identifier. If there is more than one item, such as department and position, they must be separated with a comma.
TeamIdArray		List of team identifiers, separated by commas if you wish to add more than one team.
UpdateType		Definition on how the lists of values of the `AccGroupIdArray`, `RolPosIdArray`, and `TeamIdArray` parameters will be considered in user import: ▪ When the user is saved, if 0 is entered, the values entered in the `AccGroupIdArray`, `RolPosIdArray` and `TeamIdArray` parameters will be added to the values already defined in a previous record of the user. ▪ When the user is saved, if 1 is entered, the values entered in the `AccGroupIdArray`, `RolPosIdArray` and `TeamIdArray` parameters will replace the values already defined in a previous record of the user. Note: If no value is entered, the system will consider the value 0 by default.

info

X¹ - Required if the DomaindId field is filled in.
X² - Required if the UserDomaindId field is filled in.

caution

To find out what the domain controller ID # is, you must select the return of the OID column from the following SQL:

select OID, * from ADAUTHLDAPCONFIG

If it is necessary to link the user with AD via web service, we recommend disabling user synchronization. To do that, access the Configuration > Authentication screen, go to the General options tab, and uncheck the "Enable synchronization scheduling" option.

caution

You can only insert or edit one user at a time through this method. This means that it is not possible to update a list of users by sending a single request.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:admin">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:importUser>
         <!--You may enter the following 19 items in any order-->
         <urn:UserId>?</urn:UserId>
         <urn:UserName>?</urn:UserName>
         <urn:UserLogin>?</urn:UserLogin>
         <urn:UserPassword>?</urn:UserPassword>
         <!--Optional:-->
         <urn:UserCounterSign>?</urn:UserCounterSign>
         <!--Optional:-->
         <urn:UserLanguage>?</urn:UserLanguage>
         <!--Optional:-->
         <urn:IsActive>?</urn:IsActive>
         <!--Optional:-->
         <urn:IsEnabled>?</urn:IsEnabled>
         <!--Optional:-->
         <urn:NumMaxConnections>?</urn:NumMaxConnections>
         <!--Optional:-->
         <urn:UserPhone>?</urn:UserPhone>
         <!--Optional:-->
         <urn:UserEmail>?</urn:UserEmail>
         <!--Optional:-->
         <urn:LeaderId>?</urn:LeaderId>
         <!--Optional:-->
         <urn:UserPhoto>cid:413971966625</urn:UserPhoto>
         <!--Optional:-->
         <urn:UserDomainId>?</urn:UserDomainId>
         <!--Optional:-->
         <urn:DomainId>?</urn:DomainId>
         <!--Optional:-->
         <urn:AccGroupIdArray>?</urn:AccGroupIdArray>
         <!--Optional:-->
         <urn:RolPosIdArray>?</urn:RolPosIdArray>
         <!--Optional:-->
         <urn:TeamIdArray>?</urn:TeamIdArray>
         <!--Optional:-->
         <urn:UpdateType>?</urn:UpdateType>
      </urn:importUser>
   </soapenv:Body>
</soapenv:Envelope>

Return:

ID	Description
UserID	ID of the added or edited user.
Status	Request response status.
Detail	Request details.

Code	Description
59	Language not supported by the database
60	Inexistent language