Create Company (ivnCreateCompany)
§ Intelliview NXT supports multiple companies (multi-tenancy) in a single instance of Intelliview NXT. This web service API is used to create a new company in Intelliview NXT.
§ The session user (UserName used in creating the Intelliview NXT Session using ivnInitializeSession()) should have the “Super Admin” privilege for invoking this API.
Web Service Request:
|
|
public string ivnCreateCompany(string SessonToken, string CompanyShortName, string |
|
||||
|
Web Service Request Parameters: |
|
|
|
|||
|
|
|
Parameters |
Data Type |
Description |
Remarks |
|
|
|
|
SessionToken |
String |
The unique Identification assigned for the |
|
|
|
|
|
CompanyShortName |
String |
Company Short Name (Maximum Length = 25) |
|
|
|
|
|
CompanyName |
String |
Company Name (Maximum Length = 200) |
|
|
|
|
|
CompanyDescription |
String |
Company Description (Maximum Length = 500) |
|
|
|
|
|
WebURL |
String |
Company's web URL |
|
|
|
|
|
AdminUserXML |
String |
Contains the details of Admin User in XML format. |
|
|
|
|
|
ExtraParam |
String |
Additional Parameter for future use |
|
|
Note:
§ The Company Status is set to False by default. Invoke ivnUpdateCompany to activate the company.
AdminUserXML parameter structure:
<AdminUserDetails>
<FirstName>ABC</FirstName>
<LastName>XYZ</LastName>
<UserName>ABCadmin</UserName>
<EmailID>abc@aaa.in</EmailID>
<Password>p@$$w0rd</Password>
<PhoneNo>1234568</PhoneNo>
</AdminUserDetails>
Web Service Response (Success):
<ResponseMessage>
<Message ID='SYN_REP_INFO_7505'/>
<Response Message= 'Company creation is successful'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Response (Error):
<ResponseMessage>
<Message ID='SYN_REP_ERROR_7509'/>
<Response Message= 'Company short name is not valid'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Return Parameters:
|
Parameters |
Data Type |
Description |
Remarks |
|
Message ID |
String |
The unique identification assigned |
|
|
Response Message |
String |
The Response Message is received |
|
|
Company ID |
Integer |
The unique Identification assigned |
|
|
Version No |
String |
The last digit after the third decimal |
|
Response Messages:
|
Srl.No. |
Message ID |
Message |
|
1 |
SYN_REP_ERROR_5112 |
Company name already exists |
|
2 |
SYN_REP_ERROR_5113 |
Company short name already exists |
|
3 |
SYN_REP_ERROR_5035 |
Exception has occurred. Contact your Administrator |
|
4 |
SYN_REP_ERROR_7501 |
Intelliview NXT session is expired or not initialized or |
|
5 |
SYN_REP_INFO_7505 |
Company creation is successful |
|
6 |
SYN_REP_ERROR_7508 |
User does not have super admin privileges |
|
7 |
SYN_REP_ERROR_7509 |
Company short name is not valid |
|
8 |
SYN_REP_ERROR_7510 |
Company name is not valid |
|
9 |
SYN_REP_ERROR_7523 |
User name is not valid |
|
10 |
SYN_REP_ERROR_7524 |
First name is not valid |
|
11 |
SYN_REP_ERROR_7525 |
Last name is not valid |
|
12 |
SYN_REP_ERROR_7526 |
Email ID is not valid |
|
13 |
SYN_REP_ERROR_7527 |
Password is not valid |
|
14 |
SYN_REP_ERROR_7596 |
User detail(s) is not valid |
Update Company Details (ivnUpdateCompany) >>