List Activation Codes

List Activation codes API will return the list of data that match the given query parameters.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

GET https://{tenantId}.{hostname}/digitanium/v4/users/{userName}/activationcodes?responseQrType=mpower&qrCode=true
     

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_activationcode/{userName}/?responseQrType=mpower&qrCode=true

note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body

No request body fields are required.

Query Parameters (Optional)

Parameter Name	Type	Description
qrCode	Boolean	set 'true' to retrieve qr image in base64 format in the response, set 'false' if no need to retrieve.
responseQrType	String	Format of the QR code in which you wanted to embed activation code. Set the value 'mpower' to get the mpower qr code format or Set the value to 'normal' to get the normal qr code format.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Array	Response Data - a list of all activation code informations of the given userId.
activationCode	String	Value of activationcode
activationNotAfter	String	Time after activationcode is not valid anymore. Invalid activation codes will be removed after predefined period of time. Follows Epoch time stamp.
codeCount	Integer	List of activation codes are available for the user.
userID	String	UserId of user for whom the activationcode was created

Sample Response

{
    "subSystem": 5,
    "status": "OK",
    "message": "Activation codes fetched successfully",
    "data": {
        "userId": "USER_NAME",
        "activationCodes": [
            {
                "activationNotAfter": "1586901570",
                "activationCode": "1827098",
                "qrImage": "data:image/png;base64,iVBORw..."
            }
        ],
        "codeCount": 1
    }
}

Response Status Information

Status Code	Status	Message
200	OK	Activation codes fetched successfully
401	Unauthorized	HTTP 401 Unauthorized
404	Not Found	User does not exist