Last Modified January 26, 2021
  1. Home
  2. RESTful API
  3. Licenses Status

Licenses Status

  1. API Request
  2. Status KeyWords
  3. API Response
  4. Request Examples
  5. Response Examples

 

The Licenses Status API retrieves the status of a License Code given as a string of KeyWords. Use this API when you do not need the full License Details provided by the License Details API.

HTTP Verb Element Syntax
GET URL https://api.softworkz.com/v1/Licenses/<productId>/<licenseId>/status
Body (not required)

Responds with KeyWords describing the License Status

Use if no authentication of the End-User is required, and the information will only be used within your internal processes.

Where:

Parameter Type Value Required Default
<productId> string the DNA ProductID Yes  
<licenseId> string the License Activation Code Yes  

 

Status KeyWords

The KeyWords string is made up of three key words, plus one optional keyword:

Exists Type Status
UNKNOWN
EXISTS 		ACTIVATION
EVALUATION
TEST 		AVAILABLE
RESERVED
ACTIVATED
EXPIRED
BANNED
REACTLOCKOUT
IPLOCKOUT
Optional Key Words
VALID

added if EXISTS, ACTIVATION and one of AVAILABLE, or RESERVED, or ACTIVATED is in the KeyWord string

 

API Response

Success HTTP Status Code Description
200 OK License Status JSON string is returned in Response
Error HTTP Status Code Description
400 Bad Request one of the parameters was invalid or missing - check error message in Response for details
401 Unauthorized Basic Authentication failed - verify that you are using the correct <clientId> and <apiKey> information in the Basic Authentication Header
404 Not Found The <productId> and/or the <licenseId> was not found
429 Too Many Requests You have exceeded the allowed maximum of API Requests in the period - check "X-RateLimit-Reset" for the number of seconds remaining before reset
500 Internal Error An error occured on the DNA Server - try again later. Tech Support has been notified

 

Examples of API Requests

GET Licenses Status example - returns status KeyWords for the License

curl -v -X GET https://api.softworkz.com/v1/licenses/<productId>/TEST12345/status
-H "Accept: application/json"
-u "<clientId>:<API Key>"

 

Example of API Response with License Details

{
  "Status": "EXISTS ACTIVATION ACTIVATED VALID"
}

 

Example of API Error Response

{
  "Message": "Invalid ProductId format"
}