Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following code block shows an example result of a successful request.

 

Code Block
languagejs
firstline1
linenumberstrue
{
    success: ${success},
    msg: ${message},
    data: [{
        "lsid": ${licenseServerId},
        "lsn": ${licenseServerName},
        "fid": ${featureId},
        "fns": ${featureName},
        "fv": ${featureVersion},
        "ftype": ${featureType},
        "lus": ${licensesUsed},
        "lco": ${checkoutTime},
        "lbe": ${borrowExpire},
        "uid": ${userId},
        "un": ${userName},
        "hn": ${hostName},
        "uil": ${ldapUser},
    }],
    "code": ${errorCode},
    "totalCount": ${totalCount}
}

where the response fields can be explained as follows: 

Anchor
fields def
fields def

Field
Type
Description
lsidintegerLicense Server ID.
lsnstringLicense Server name.
fidintegerFeature ID.
fnsstringFeature Name.
ftypestringFeature type.
fvstringFeature version.

lus

integer

Total number of licenses used by user on host.

lco

string

Date when license was checked out. The date is in ' YYYY-MM-DD HH:MM ' format; for example 2017-05-20 10:15.

lbe

string

Borrow expiration date. The date is in ' YYYY-MM-DD HH:MM ' format; for example, 2017-05-20 10:15.

uidintegerUser ID.

un

string

Username.

hn

string

Hostname.

uil

boolean

Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field.

msg

string

Error message returned on failure.

success

boolean

Indicates whether your API request was successfully processed. 

codeinteger

Error code for unsuccessful request.

totalCountinteger

Total number of all matching results.

...