Interface ILicenseManagementWS
Namespace: Microsoft.Licensing.LicenseIssue
Assembly: Slps.Domain.Interfaces.dll
Methods
AuthorizeRenewal(String, Int32)
Authorize renewal for a the next x periods
Declaration
DateTime AuthorizeRenewal(string licenseId, int numberOfPeriods)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | licenseId | The id of the subscription license |
| System.Int32 | numberOfPeriods | The number of periods for which renewal is authorized. It is offset from the start of the current period. A positive number of period must be supplied |
Returns
| Type | Description |
|---|---|
| System.DateTime | The date that renewal is authorized until. Renewals after that date will be prevented. |
CreateLicense(LicenseInfo)
Creates a license in the Software Potential service
Declaration
License CreateLicense(LicenseInfo licenseInfo)Parameters
| Type | Name | Description |
|---|---|---|
| LicenseInfo | licenseInfo | The license parameters to be used when creating the license. |
Returns
| Type | Description |
|---|---|
| License |
DeactivateLicenseForDevice(String, String)
Deactivates device against activated license.
Declaration
void DeactivateLicenseForDevice(string deviceId, string licenseId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | deviceId | Device Id to Deactivate |
| System.String | licenseId | License Id |
DisableAutoRenewal(String)
Disable the automatic renewal of a license
Declaration
void DisableAutoRenewal(string licenseId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | licenseId | The id of the subscription license |
DisableLicenseByActivationKey(String)
Disables a license in the Software Potential service for the specified Activation Key.
Declaration
void DisableLicenseByActivationKey(string activationKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | activationKey | The Activation Key of the licenses to be disabled. |
EnableAutoRenewal(String)
Enable the automatic renewal of a license
Declaration
void EnableAutoRenewal(string licenseId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | licenseId | The id of the subscription license |
GetActivationsByFilter(ActivationFilter, ActivationRetrievalOptions, ref Int32)
Returns all activations satisfying the constraints specified in the ActivationFilter. Only fields indicated by the ActivationRetrievalOptions are returned.
Uses paging to limit the number of returned items in any request. Call this method iteratively, passing a variable with
value of 0 on the first request, and let the server increment the value for each subsequent request. Iteration is complete
when pageIndex is -1, indicating no further results are available.
Declaration
Activation[] GetActivationsByFilter(ActivationFilter filter, ActivationRetrievalOptions retrievalOptions, ref int pageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| ActivationFilter | filter | Constraints to qualify which |
| ActivationRetrievalOptions | retrievalOptions | Flag to indicate which data fields should be returned in the |
| System.Int32 | pageIndex | Set to 0 on the first request, and then call this method until this value becomes -1. |
Returns
| Type | Description |
|---|---|
| Activation[] |
GetCountOfLicensesByFilter(LicenseFilter)
Returns the count of licenses satisfying the input filter criteria.
Declaration
int GetCountOfLicensesByFilter(LicenseFilter filter)Parameters
| Type | Name | Description |
|---|---|---|
| LicenseFilter | filter | Various filter criteria, which are combined together to restrict the returned results by date ranges or IDs. Any fields set to null are ignored. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Count of licenses satisfying the input filter criteria. |
GetLicenseByActivationKey(String)
Returns license for the specified Activation Key.
Declaration
License GetLicenseByActivationKey(string activationKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | activationKey | The Activation Key of the licenses to retrieve information for. |
Returns
| Type | Description |
|---|---|
| License |
GetLicenseById(String)
Returns detailed license information for a single instance of a license.
Declaration
License GetLicenseById(string licenseId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | licenseId | Identifies which license to retrieve properties for |
Returns
| Type | Description |
|---|---|
| License | A License object, populated with the specified data values |
GetLicensesByFilter(LicenseFilter, LicenseRetrievalOptions, ref Int32)
Returns licenses satisfying the input filter criteria.
Uses paging to limit the number of returned items in any request. Call this method iteratively, passing a variable with
value of 0 on the first request, and let the server increment the value for each subsequent request. Iteration is complete
when pageIndex is -1, indicating no further results are available.
Declaration
License[] GetLicensesByFilter(LicenseFilter filter, LicenseRetrievalOptions retrievalOptions, ref int pageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| LicenseFilter | filter | Various filter criteria, which are combined together to restrict the returned results by date ranges or IDs. Any fields set to null are ignored. |
| LicenseRetrievalOptions | retrievalOptions | Flag to indicate which data fields should be returned in the |
| System.Int32 | pageIndex | Set to 0 on the first request, and then call this method until this value becomes -1. |
Returns
| Type | Description |
|---|---|
| License[] | Array of licenses satisfying the input filter criteria. |
GetLicenseSummariesByLicenseIds(String[])
Returns summary information for the specified license IDs. If the license has not had any activations, the LastActivationDate value will not be assigned.
Declaration
LicenseSummary[] GetLicenseSummariesByLicenseIds(string[] licenseIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | licenseIds | IDs of licenses to retrieve information for. |
Returns
| Type | Description |
|---|---|
| LicenseSummary[] |
GetProductById(String)
Gets product for a given Product ID. This method is intended for use for Business System Integration Requires authentication.
Declaration
Product GetProductById(string productId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | productId |
Returns
| Type | Description |
|---|---|
| Product | Product object |
GetProducts()
Gets products associated with the current vendor. This method is currently intended for use by the Software Potential Code Protector. Requires authentication.
Declaration
Product[] GetProducts()Returns
| Type | Description |
|---|---|
| Product[] | array of Product objects |
GetProductsByFilter(ProductFilter, ProductRetrievalOptions, ref Int32)
Gets products associated with the current vendor. This method is currently intended for use for Business System Integration.
Uses paging to limit the number of returned items in any request. Call this method iteratively, passing a variable with
value of 0 on the first request, and let the server increment the value for each subsequent request. Iteration is complete
when pageIndex is -1, indicating no further results are available.
Requires authentication.
Declaration
Product[] GetProductsByFilter(ProductFilter filter, ProductRetrievalOptions retrievalOption, ref int pageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| ProductFilter | filter | Used to search for products that should be returned. |
| ProductRetrievalOptions | retrievalOption | Indicates what fields of the |
| System.Int32 | pageIndex | Set to 0 on the first request, and then call this method until this value becomes -1. |
Returns
| Type | Description |
|---|---|
| Product[] | array of Product objects for the specified pageIndex |
GetSkuById(String)
Retrieves a Stock Keeping Unit (SKU) object matching the specified ID.
Declaration
Sku GetSkuById(string skuId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | skuId | Identifies the SKU object to return |
Returns
| Type | Description |
|---|---|
| Sku | SKU object matching the input ID |
GetSkusByFilter(SkuFilter, SkuRetrievalOptions, ref Int32)
Gets Stock Keeping Unit information about a product. This method is currently intended for use for Business System Integration.
Uses paging to limit the number of returned items in any request. Call this method iteratively, passing a variable with
value of 0 on the first request, and let the server increment the value for each subsequent request. Iteration is complete
when pageIndex is -1, indicating no further results are available.
Requires authentication.
Declaration
Sku[] GetSkusByFilter(SkuFilter filter, SkuRetrievalOptions retrievalOptions, ref int pageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| SkuFilter | filter | Identifies which SKUs to return. |
| SkuRetrievalOptions | retrievalOptions | Indicates what fields of the returned objects should be returned. |
| System.Int32 | pageIndex | Set to 0 on the first request, and then call this method until this value becomes -1. |
Returns
| Type | Description |
|---|---|
| Sku[] | array of SKU objects for the specified pageIndex |
IssueLicenseByTemplate(String, String, CustomTag[])
Allows issuing a license according to a specified template. Requires authentication. Requires the following permissions: LicensesIssue
Declaration
string IssueLicenseByTemplate(string templateLicenseKey, string licenseDescription, CustomTag[] customTags)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | templateLicenseKey | License key of a template license |
| System.String | licenseDescription | Description of a license. If empty, the description from the template will be used |
| CustomTag[] | customTags | List of custom name/value pairs that will be associated with the issued license. Can be null. |
Returns
| Type | Description |
|---|---|
| System.String | License key of the newly issued license |
Exceptions
| Type | Condition |
|---|---|
| System.Web.Services.Protocols.SoapException |
SetSubscriptionRenewUntil(String, DateTime)
Set the date licenses can be renewed until to a given UTC date value
Declaration
void SetSubscriptionRenewUntil(string licenseId, DateTime renewUntilDateUtc)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | licenseId | The id of the subscription license |
| System.DateTime | renewUntilDateUtc | A UTC Date licenses can be renewed until |
UpdateLicense(License, Boolean)
Updates a license in the Software Potential service and optionally can force the license to be reissued.
Declaration
void UpdateLicense(License license, bool andReissue)Parameters
| Type | Name | Description |
|---|---|---|
| License | license | The updated license data to be applied to an existing license on |
| System.Boolean | andReissue | Flag to indicate whether the license should be reissued after update |