Skip to main content
Version: 2.2.0

newExternalUser

This method allows importing external users.

Java class
Requestweb/wwwroot/ws/java/administration/importUserRequestType.java
Returnweb/wwwroot/ws/java/administration/importUserResponseType.java

Request:

IDRequiredDescription
NAMEXUser's name.
PASSWORDXUser's password.
EMAILXUser's e-mail address.
NMIDXLicense ID #.
LANGUAGEXEnter the user's language code, in accordance with the "Database Encoding" column of the Localization section, in the System Requirements document.
TELEPHONEXUser's phone #.
COMPANYID # of the user's company.
POSITIONName of the user's position.
DEPARTMENTName of the user's department.
NRCONCURRENTLOGINSMaximum number of the user's simultaneous connections.
OBSERVATIONComments.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:admin">
<soapenv:Header/>
<soapenv:Body>
<urn:newExternalUser>
<!--You may enter the following 11 items in any order-->
<urn:NAME>?</urn:NAME>
<urn:PASSWORD>?</urn:PASSWORD>
<urn:EMAIL>?</urn:EMAIL>
<urn:NMID>?</urn:NMID>
<urn:LANGUAGE>?</urn:LANGUAGE>
<urn:TELEPHONE>?</urn:TELEPHONE>
<!--Optional:-->
<urn:COMPANY>?</urn:COMPANY>
<urn:POSITION>?</urn:POSITION>
<urn:DEPARTMENT>?</urn:DEPARTMENT>
<urn:NRCONCURRENTLOGINS>?</urn:NRCONCURRENTLOGINS>
<urn:OBSERVATION>?</urn:OBSERVATION>
</urn:newExternalUser>
</soapenv:Body>
</soapenv:Envelope>

Return:

IDDescription
StatusSUCCESS: SUCCESS
FAILURE: FAILURE
DetailSUCCESS: Record successfully added.
FAILURE: message regarding the error that occurred.
CodeSUCCESS: 1.
FAILURE: Code regarding the error that occurred:
â–ª -1 - Unexpected error.
â–ª 2 - Invalid license key.
â–ª 3 - The maximum size for this field is 50.
â–ª 4 - E-mail already registered or associated.
â–ª 5 - Null user login.
â–ª 6 - Null user ID.
â–ª 7 - Null user name.
â–ª 8 - Null password.
â–ª 9 - Null or inexistent language.
â–ª 30 - Max. number of connections.