Initialize Session (ivnInitializeSession)

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 Type	Description	Remarks
CompanyShortName	String	Company Short Name	If the subsequent web services API call is for Creating a Company then the default value is “NEW”
UserName	String	User Name defined in Intelliview NXT with the required privileges and permissions to perform the operations	User Name should have been defined already in Intelliview NXT
Password	String	Password as defined in	Password for the
Password	String	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 the type of authentication to be performed.	1 - indicates standard Intelliview authentication
ApplicationType	Integer	Application Type	Default Value = 1;
Language	String	Language in which the messages are to be provided. Represented in ISO 639-1 two character code	Only English ('en') is supported in the current version.
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>

Web Service Response (Error):

</ResponseMessage>

Web Service Return Parameters:

Parameters	Data Type	Description	Remarks
Message ID	String	Unique identification assigned to the response message in Intelliview NXT.
Response Message	String	The Response Message is received from Intelliview NXT.
SessionToken	String	Unique session token assigned by the Intelliview NXT on successful processing of the Initialize Session Request	Returned on success. The Session Token is required to be used in all the subsequent web services API requests.
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 Administrator
2	SYN_REP_ERROR_5086	Invalid user name/password
3	SYN_REP_ERROR_7501	Intelliview NXT session is expired or not initialized or not valid.
4	SYN_REP_INFO_7503	Intelliview NXT session initialization is successful
5	SYN_REP_ERROR_7507	Intelliview NXT session is not initialized / expired.
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

Close Session (ivnCloseSesion) >>