GET license

This request performs the following:

>Provides provisioning information related to entitlements, products, and features.

>Provides license consumption information, such as the number of running sessions (in the case of licenses with the limited concurrency limit) and the number of usage count consumed (in the case of licenses with the limited usage limit).

>Checks the license availability for a user.

Type

GET

URI

<SCC_URL>/licenses?customer={customer}&user={user}&featureName={fname}&featureVersion={fver}&Entitlement={EID}&productName={pname}&productVersion={pver}&userSpecificEnititlement={trueORfalse}

The <SCC_URL> represents the Cloud Connect URL sent by Directory Service (also called, YPS) in response to the POST registration request.

Example URI

https://fra01-he02.trial.sentinelcloud.com/scc/licenses?customer=c1&user=u1&featureName=fname1&featureVersion=1.0&Entitlement=aced45&productName=product1&productVersion=1.0&userSpecificEnititlement=true

URI Parameters

The following parameters are used to retrieve the license information:

Input Combinations

Following are the combinations for the request parameters:

Further filtering can be done based on userSpecificEntitlement and user parameters. For details, refer to the URI Parameters table given above.

Request Body

None

Response Body

NOTE   The responses shown below are for a given entitlementId, productName, and productVersion.

Case 1: When an entitlement contains a feature with unlimited concurrency and unlimited usage count

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<licenses>
	<entitlement>
		<entitlementId>51f0c54b-24e9-43a6-bf22-ce8738da59fe</entitlementId>
		<product>
			<productName>m1</productName>
			<productVersion>1</productVersion>
			<feature>
				<featureId>57</featureId>
				<featureName>z1</featureName>
				<featureVersion/>
				<usable>true</usable>
				<usabilityStatus>Available</usabilityStatus>
				<concurrencyLimit>Unlimited</concurrencyLimit>
				<startDate>2017-01-04T00:00:00Z</startDate>
				<endDate>2018-01-05T00:00:00Z</endDate>
				<vendorInfo/>
				<endDateGraceDuration>0</endDateGraceDuration>
				<usageLimit>Unlimited</usageLimit>
			</feature>
		</product>
	</entitlement>
</licenses>

Case 2: When an entitlement contains a feature with limited concurrency

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<licenses>
	<entitlement>
		<entitlementId>3c6d37dd-7c23-453d-8f07-96f776d301c7</entitlementId>
		<product>
			<productName>calculator</productName>
			<productVersion>2</productVersion>
			<feature>
				<featureId>19</featureId>
				<featureName>add</featureName>
				<featureVersion>1</featureVersion>
				<usable>true</usable>
				<usabilityStatus>available</usabilityStatus>
				<concurrencyLimit>5</concurrencyLimit>
				<concurrencyCriteria>per user</concurrencyCriteria>
				<runningSessions>0</runningSessions>
				<startDate>2016-07-18T00:00:00Z</startDate>
				<endDate>2017-07-18T00:00:00Z</endDate>
				<vendorInfo>vendorinfo</vendorInfo>
				<endDateGraceDuration>3</endDateGraceDuration>
				<usageLimit>unlimited</usageLimit>
			</feature>
		</product>
	</entitlement>
</licenses>

Case 3: When an entitlement contains a feature with limited usage count

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<licenses>
	<entitlement>
		<entitlementId>3c6d37dd-7c23-453d-8f07-96f776d301c7</entitlementId>
		<product>
			<productName>calculator</productName>
			<productVersion>3</productVersion>
			<feature>
				<featureId>16</featureId>
				<featureName>add</featureName>
				<featureVersion>1</featureVersion>
				<usable>true</usable>
				<usabilityStatus>available</usabilityStatus>
				<concurrencyLimit>unlimited</concurrencyLimit>
				<startDate>2016-07-18T00:00:00Z</startDate>
				<endDate>2017-07-18T00:00:00Z</endDate>
				<vendorInfo>vendorinfo</vendorInfo>
				<usageLimit>5</usageLimit>
				<usageCountConsumed>0</usageCountConsumed>
				<usageCountGrace>10</usageCountGrace>
				<endDateGraceDuration>2</endDateGraceDuration>
			</feature>
		</product>
	</entitlement>
</licenses>

In case of error:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
	<status>Fail</status>
	<errorCode>error_code</errorCode>
	<errorDescription>error_message</errorDescription>
</error>

<startDate>2016-08-03T00:00:00Z</startDate>

<endDate>2020-12-31T00:00:00Z</endDate>

Response Schema

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="licenses">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="entitlement" minOccurs='1'>
        <xs:complexType>
          <xs:sequence>
           <xs:element type="xs:string" name="entitlementId" minOccurs='1' maxOccurs='1'/>
            <xs:element name="product" minOccurs='1'>
              <xs:complexType>
                <xs:sequence>
  		     <xs:element type="xs:string" name="productName"/>
                    <xs:element type="xs:string" name="productVersion"/>
                    <xs:element name="feature" minOccurs='1'>
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element type="xs:int" name="featureId"/>
                          <xs:element type="xs:string" name="featureName"/>
                          <xs:element type="xs:string" name="featureVersion"/>
                          <xs:element type="xs:string" name="usable"/>
                          <xs:element type="xs:string" name="usabilityStatus"/>
                           <xs:element name="concurrencyLimit">
			    <xs:simpleType>
			    <xs:union memberTypes="xs:int xs:string"/>
			    </xs:simpleType>
			    </xs:element>
                          <xs:element type="xs:dateTime" name="startDate"/>
                          <xs:element type="xs:dateTime" name="endDate"/>
                          <xs:element type="xs:string" name="vendorInfo"/>
                          <xs:element type="xs:int" name="endDateGraceDuration"/>
                          <xs:element type="xs:string" name="concurrencyCriteria" minOccurs='0'/>
                          <xs:element type="xs:int" name="runningSessions" minOccurs='0'/>
			  <xs:element type="xs:string" name="usageCountGrace" minOccurs='0'/>
			  <xs:element type="xs:int" name="usageCountConsumed" minOccurs='0'/>
                          <xs:element name="usageLimit" >
			  <xs:simpleType>
			 <xs:union memberTypes="xs:int xs:string"/>
			   </xs:simpleType>
			  </xs:element>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Error Codes

See Also: Common Error Codes