Create User (ivnCreateUser)
§ This web service is invoked to create the user in Intelliview NXT for a given company
§ User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API.
Web Service Request:
|
|
|
public string ivnCreateUser(string SessionToken, int CompanyID, string UserName, string |
|
|||
|
Web Service Request Parameters: |
|
|
|
|||
|
|
Parameters |
Data Type |
Description |
Requirement |
||
|
|
SessionToken |
String |
The unique Identification assigned to the Intelliview |
|
|
|
|
|
Company ID |
Integer |
The unique Identification assigned to the Company in Intelliview NXT. |
|
|
|
|
|
UserName |
String |
User Name used for login/authentication |
|
|
|
|
|
Password |
String |
Password for the given username |
|
|
|
|
|
FirstName |
String |
First Name of the user |
|
|
|
|
|
LastName |
String |
Last Name of the User |
|
|
|
|
|
EmailID |
String |
User Email ID |
|
|
|
|
|
Department |
String |
User Department |
|
|
|
|
|
PhoneNo |
String |
User Phone Number |
|
|
|
|
|
GroupNameList |
String[] |
One or more Group Names passed in a string array |
|
|
|
|
|
AdminUser |
Boolean |
User is an Admin if the value set to 'True'. The API |
|
|
|
Web Service Response (Success):
<ResponseMessage>
<Message ID='SYN_REP_INFO_7562'/>
<Response Message= 'User creation is successful'/>
<User ID='7'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Response (Error):
<ResponseMessage>
<Message ID='SYN_REP_ERROR_7522'/>
<Response Message= 'Datamodel ID is not valid'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Return Parameters:
|
Parameters |
Data Type |
Description |
Remarks |
|
Message ID |
String |
The unique identification assigned to the |
|
|
ResponseMessage |
String |
The Response Message is received from |
Only English Language |
|
UserID |
Integer |
User ID |
Returned on success; |
|
Company ID |
Integer |
The unique Identification assigned to the |
|
|
Version No |
String |
The last digit after the third decimal point |
|
Response Messages:
|
Srl.No. |
Message ID |
Message |
|
1 |
SYN_REP_ERROR_5035 |
Exception has occurred. Contact your Administrator |
|
2 |
SYN_REP_ERROR_5037 |
Unable to create User |
|
3 |
SYN_REP_ERROR_5041 |
User name already exists |
|
4 |
SYN_REP_ERROR_7501 |
Intelliview NXT session is expired or not initialized or |
|
5 |
SYN_REP_ERROR_7511 |
Company ID is not valid |
|
6 |
SYN_REP_ERROR_7523 |
User name is not valid |
|
7 |
SYN_REP_ERROR_7524 |
First name is not valid |
|
8 |
SYN_REP_ERROR_7525 |
Last name is not valid |
|
9 |
SYN_REP_ERROR_7526 |
Email ID is not valid |
|
10 |
SYN_REP_ERROR_7527 |
Password is not valid |
|
11 |
SYN_REP_ERROR_7560 |
Group name is not valid |
|
12 |
SYN_REP_INFO_7562 |
User creation is successful |