ClaimKey Webservice

Get claim key

Get the claim key with the specified uuid. A claim key represents one purchased term: startDate and endDate are the term boundaries and gracePeriodEndDate is 30 days past endDate. Note that claimStartDate and claimEndDate are when the key was redeemed, not term boundaries, and that only claim keys of type NEW carry a startDate - a RENEWAL key extends the terms it renews and carries only an endDate.

post/api/license/claimkey/getClaimKey

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/license/claimkey/getClaimKey
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "claimKey": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.