Navigation:  Integration via SOAP web services > Published web services > Administration >

importUser

Previous  Top  Next

This method enables to add/edit:

User general 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 reg. code #.

UserName

X

User name.

UserLogin

X

Name used by the user to log into the system

UserPassword

X

User password.

UserCounterSign

 

User countersign.

UserLanguage

 

Enter the user 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 phone #

UserEmail

X

User e-mail address.

LeaderId

 

User leader ID #

UserPhoto

 

User image in binary format 64.

UserDomainId

X1

User unique ID # in the domain controller.

DomainId

X2

AD domain ID # added to SoftExpert Suite to which the user is linked. (Used in synchronizing user data with Domain controller).

AccGroupIdArray

 

List of access groups IDs # separated by commas if you wish to add more than one.

RolPosIdArray

 

List of department ID # and position ID #. For each item that represents the department and position, it must be represented as:

area-identifier#department-identifier. In case of more than one item such as department and position, a comma must be used to separate it.

TeamIdArray

 

List of team IDs # separated by commas if you wish to add more than one team.

UpdateType

 

Definition on how the AccGroupIdArray, RolPosIdArray and TeamIdArray parameters list of values will be considered in the import of the user:

When saving the user, 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 saving the user, if 1 is entered, the values reported in the AccGroupIdArray, RolPosIdArray and TeamIdArray parameters will replace the values already defined in the record of the user set previously.

Note: If no value is entered, the system will consider the value 0 by default.

 

X¹ - Required if the "DomaindId" field is filled out.

X² - Required if the "UserDomaindId" field is filled out.

 

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

select OID, * from ADAUTHLDAPCONFIG

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

 

Return

ID #

Description

UserID

ID # of the user added or edited

Status

Status of the request answer.

Detail

Details of the request.

 

Code

Description

59

Language not supported by the database

60

Inexistent language