Return Codes and Messages

This page lists the return codes and messages that can be expected from the SLM Plus API when using different license management actions. Each action has specific responses for success, errors, and various conditions, helping you to interpret API responses quickly.

Common Return Codes

The following return codes and messages are commonly used across all actions:

• Success: The action was completed successfully.

  • Code: success
  • Message: Varies by action; often includes confirmation details like license key or activation info.

• Error: An error occurred during the action.

  • Code: error
  • Message: Details the error; may include specific guidance.

• Invalid License Key: The license key provided is not valid.

  • Code: LICENSE_INVALID
  • Message: "Invalid license key provided."

Action-Specific Return Codes

1. Creating a License

• License Created Successfully:

  • Code: LICENSE_CREATED
  • Message: "License successfully created."

• Create License Failed: Error during license creation.

  • Code: CREATE_FAILED
  • Message: "License creation failed. Specify required fields."

2. Activating a License

• License Activated Successfully:

  • Code: LICENSE_VALID
  • Message: "License key activated."

• License Expired: License has expired.

  • Code: LICENSE_EXPIRED
  • Message: "Your license key has expired. Please renew."

• License Blocked: License has been blocked.

  • Code: LICENSE_BLOCKED
  • Message: "Your license key is blocked. Contact support."

• License Already in Use: License is already activated for the specified domain or device.

  • Code: LICENSE_IN_USE
  • Message: "License key already in use on the specified domain or device."

• Max Domains Reached: Maximum allowed domains have been activated for this license.

  • Code: REACHED_MAX_DOMAINS
  • Message: "Reached maximum allowable domains for this license."

• Max Devices Reached: Maximum allowed devices have been activated for this license.

  • Code: REACHED_MAX_DEVICES
  • Message: "Reached maximum allowable devices for this license."

3. Deactivating a License

• License Deactivated Successfully:

  • Code: KEY_DEACTIVATE_SUCCESS
  • Message: "The license key has been deactivated."

• Domain Already Inactive: The specified domain is already inactive.

  • Code: DOMAIN_ALREADY_INACTIVE
  • Message: "The license key on this domain is already inactive."

• Device Already Inactive: The specified device is already inactive.

  • Code: DEVICE_ALREADY_INACTIVE
  • Message: "The license key on this device is already inactive."

• Domain or Device Missing: The specified domain or device was not found.

  • Code: DOMAIN_MISSING
  • Message: "The specified domain or device was not found."

4. Checking License Status

• License Active:

  • Code: LICENSE_EXIST
  • Message: "License key details retrieved. Status: Active."

• License Expired:

  • Code: LICENSE_EXPIRED
  • Message: "License key has expired."

• License Blocked:

  • Code: LICENSE_BLOCKED
  • Message: "License key is blocked."

• Invalid License Key:

  • Code: LICENSE_INVALID
  • Message: "Invalid license key provided."

5. Retrieving License Information

• Information Retrieved Successfully:

  • Code: LICENSE_EXIST
  • Message: "License key details retrieved."

• Invalid License Key: The license key provided is not valid.

  • Code: LICENSE_INVALID
  • Message: "Invalid license key provided."

Notes on Error Handling

• Generic Errors: For unexpected errors or missing required fields, a general error message is returned, typically with error as the code.
• Troubleshooting: Refer to the Troubleshooting Guide (if available) for common error resolutions.

This list of return codes and messages can be used to interpret and manage responses from the SLM Plus API effectively.