GetStatus Method

The GetStatus method gets the account status to be used for activation or deactivation.

Syntax

C#

public GetStatusRes GetStatus(string ActivationKey)

XML

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<GetStatus xmlns="http://tempuri.org/">

<ActivationKey>string</ActivationKey>

</GetStatus>

</soap:Body>

</soap:Envelope>

Parameters

ActivationKey

The Activation Key to access the account.

Return Value

C#

public struct GetStatusRes

{

public int ErrorCode;

public string ErrorMessage;

public int ActivationMode;

public bool Activated;

public bool Destroyed;

public int MaxActivation;

public int ActivationCount;

public string RegIDTran;

public int LicUpgradeID;

}

XML

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<GetStatusResponse xmlns="http http://tempuri.org/">

<GetStatusResult>

<ErrorCode>int</ErrorCode>

<ErrorMessage>string</ErrorMessage>

<ActivationMode>int</ActivationMode>

<Activated>boolean</Activated>

<Destroyed>boolean</Destroyed>

<MaxActivation>int</MaxActivation>

<ActivationCount>int</ActivationCount>

<RegIDTran>string</RegIDTran>

<LicUpgradeID>int</LicUpgradeID>

</GetStatusResult>

</GetStatusResponse>

</soap:Body>

</soap:Envelope>

ErrorCode

Returns 0 if success; otherwise, see the Error Code.

ErrorMessage

Returns error message if the ErrorCode is not 0.

ActivationMode

Returns the current mode of activation.

Value	Meaning
MODE_NOT_ APPLICABLE (0)	Not applicable Mode. Any activation is not applicable. This mode guides the client to show an error message.
MODE_LICENSE_ ACTIVATION (1)	License Activation Mode. The account is ready for first-time activation (i.e.the account has the Activated field unchecked and the LicKeyTran and MasterLicenseCust fields are empty). This mode guides the client to call the ActivateLicense method in which the License Key will be generated from the MasterLicense of the product associated with the account.
MODE_LICENSE_ TRANSFER (2)	License Transfer Mode. The account is ready for transferring the license from the server to the client (i.e. the account has the Activated field checked and the LicKeyTran is available). This mode guides the client to call the ActivateLicense method in which the License Key will be generated from the LicKeyTran.
MODE_LICENSE_ CUSTOMIZATION (3)	License Customization Mode. The account is ready for activation using the custom license (i.e. the account has the Activated field unchecked, the Reactivated field is checked, and the MaserLicenseCust is available). This mode guides the client to call the ActivateLicense method in which the License Key will be generated from the MasterLicenseCust.
MODE_LICENSE_ REPLACEMENT_OR_ DEACTIVATION (4)	License Replacement or Deactivation Mode. The account is ready for either license replacement or deactivation (i.e. the account has the Activated field checked and the ActivationCount is less than the MaxActivation). This mode guides the client to call the ActivateLicense method for license replacement purposes. This mode also guides the client to call the DeactivateLicense to transfer the license back to the server.
MODE_LICENSE_ DEACTIVATION (5)	License Deactivation Mode. The account is ready for deactivation (i.e. the account has the Activated field checked and the ActivationCount is equal to the MaxActivation). This mode guides the client to call the DeactivateLicense method to transfer the license back to the server.
MODE_LICENSE_ DESTROYED (6)	License Destroyed Mode. The client has destroyed the license. The Destroy-Code is verified and the account is terminated (i.e. the Activated field is unchecked and the Destroyed field is checked). This mode guides the client to show an error message.
MODE_LICENSE_ REACTIVATION_ REQUEST (7)	License Reactivation Request Mode. The account requests the client to reactivate the license. This is because the account is updated with a custom license (i.e. the Reactivation field is checked and the MasterLicenseCust is available). This mode guides the client to call the DeactivateLicense method so that it can call the ActivateLicense method for reactivation, which the Liense Key will be generated from the MasterLicenseCust.

Activated

Returns the flag of activation. True means the account is activated. False means the account is not yet activated or deactivated.

Destroyed

Returns the flag of destroying license. True means the Destroy-Code is verified and the license is destroyed. False means the license is not destroyed.

MaxActivation

Returns the maximum number of activations.

ActivationCount

Returns the activation count.

RegIDTran

Returns the Registration ID to be used with the method TransferLicense of the KeyCheck Class Library to deactivate the license. If RegIDTran is “”, the account is not yet activated.

LicUpgradeID

Returns the License Upgrade ID to request the client to upgrade (reactivate) the license.

See Also

GetStatus2