Retrieval methods
Login
This method allows a publishing target to log into the IRC application server by providing valid credentials - IRC user name and password. This method returns an authentication object along with a generated security token. The same authentication object should be used by the target application while accessing the data from IRC.
Syntax:
Public Boolean Login(ref AuthInfo objAuthInfo); Parameters:
| Parameter | Description |
|---|---|
| Auth Object | Authentication object with IRC user name and password provided to the application consuming the web service. The timeout value for Auth Object is configurable and is maintained in PUBLISHINGFRAMEWORKCONFIG.XML. Its default value configured as 30 minutes. If the Login method has timed out then internally every API will login again with the user name and password provided in Auth object. |
Example
BizRightsPublishingFramework.AuthInfo objAuthInfo = new
BizRightsPublishingFramework.AuthInfo();
BizRightsPublishingFramework.PublishingWebServices objMyImplementation = new
BizRightsPublishingFramework.PublishingWebServices();
objAuthInfo.UserName = “BizPFUser”;
objAuthInfo.Password = “BizPFPassword”;
Boolean boolAuthStatus = objMyImplementation.Login(objAuthInfo);
Response.Write(objAuthInfo.SecurityToken); Logout
This method allows a publishing target to logout from IRC application server. This method voids the security token provided for the web user to access data from IRC.
Syntax:
Public Boolean Logoff(ref AuthInfo objAuthInfo); Parameters:
| Parameter | Description |
|---|---|
| Auth Object | Authentication object with IRC user name and Password provided to the application consuming the web service. |
Example
BizRightsPublishingFramework.PublishingWebServices objMyImplementation = new
BizRightsPublishingFramework.PublishingWebServices();
Boolean boolAuthStatus = objMyImplementation.Logoff(objAuthInfo);