§ |
This web service establishes the Intelliview NXT application level session for authentication and security based on the UserName and credentials. |
§ |
The timeout parameter allows the application to specify the duration of the session before the session expires. |
§ |
If the web services API invocation is successful, then the response will contain the unique Session Token and the Company ID. The Session Token is required to be used for each of the further web service invocation. |
Web Service Request:
public string ivnInitializeSession(string CompanyShortName, string UserName, string Password, int Timeout=0, int AuthType, int ApplicationType, string Language, string ExtraParam) |
Web Service Request Parameters:
Parameters |
Data |
Description |
Remarks |
CompanyShortName |
String |
Company Short Name |
If the subsequent web |
UserName |
String |
User Name defined in |
User Name should |
Password |
String |
Password as defined in |
Password for the |
Intelliview NXT |
specified UserName |
||
Timeout |
Integer |
Session Timeout in minutes |
Timeout = 0 indicates |
after which the session will |
no expiry; Default is |
||
expire. |
'0' |
||
AuthType |
Integer |
Authentication Type indicates |
1 - indicates standard |
ApplicationType |
Integer |
Application Type |
Default Value = 1; |
Language |
String |
Language in which the
|
Only English ('en') is |
ExtraParam |
String |
Additional field for future use. |
Default value is Null; |
Note: |
|
§ |
For invoking the create company API for creating new company, the Company Short Name is to be initialized with “NEW”. |
§ |
The user (passed through User Name parameter) is required to have the necessary privileges and permissions in Intelliview NXT to perform the web services invoked following the ivninitializesession. |
Web Service Response (Success):
<ResponseMessage> <Message ID='SYN_REP_INFO_7503'/> <Response Message='Intelliview NXT session initialization is successful'/> <Session Token='aa773e46-61d6-4597-ad35-e69f0666dbd1'/> <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 |
Unique identification assigned to |
|
Response Message |
String |
The Response Message is |
|
SessionToken |
String |
Unique session token assigned |
Returned on success. The Session Token is required to |
Company ID |
Integer |
The unique Identification assigned to the Company by Intelliview NXT. |
|
Version No |
String |
The last digit after the third decimal point is assigned to indicate the version of the web services API. |
|
Response Messages:
Srl.No. |
Message ID |
Message |
1 |
SYN_REPO_ERROR_5035 |
Exception has occurred. Contact your |
2 |
SYN_REP_ERROR_5086 |
Invalid user name/password |
3 |
SYN_REP_ERROR_7501 |
Intelliview NXT session is expired or not |
4 |
SYN_REP_INFO_7503 |
Intelliview NXT session initialization is |
5 |
SYN_REP_ERROR_7507 |
Intelliview NXT session is not initialized / |
6 |
SYN_REP_ERROR_7509 |
Company short name is not valid |
7 |
SYN_REP_ERROR_7538 |
Authentication type is not valid |
8 |
SYN_REP_ERROR_7539 |
Application type is not valid |