GET /service/api/ecom/shop/products/{keycode}

Gets a license by its keycode.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
keycode

The product keycode.

string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/ecom/shop/products/661894646EE54CDA9D1A

Body Parameters

None.

Response Information

Resource Description

The license which represents a set of subscriptions to particular products.

GetProductLicenseResponseServiceModel
NameDescriptionTypeAdditional Information
LicenseId

A unique identifier for the license that was queried.

integer

None.

Keycode

Keycode identifying the license.

string

None.

ProductLineDescription

Description of the associated product line.

string

None.

ParentLicenseId

Unique identifier for the parent license.

integer

None.

ParentKeycode

The keycode for the parent license.

string

None.

ChildLicenseActivations

Number of activations in child licenses.

integer

None.

PartnerStartDate

Start date of the partner.

date

None.

Profile

A dictionary of profiles.

Dictionary of string [key] and GetProductLicenseResponseServiceModel_LicenseProfile [value]

None.

Customer

The customer associated to this license.

GetProductLicenseResponseServiceModel_Customer

None.

Sample Response

{
  "LicenseId": 197027008,
  "Keycode": "D41A6B3BCC094B41963F",
  "ProductLineDescription": "Webroot Business",
  "ParentLicenseId": 157701103,
  "ParentKeycode": "CB43F7FC84814893AD7C",
  "ChildLicenseActivations": 9,
  "PartnerStartDate": "2021-09-23T00:49:02",
  "Profile": {
    "SAEP": {
      "LicenseCategoryName": "SAEP",
      "LicenseCategoryDescription": "Webroot Endpoint Protection",
      "LicenseSeats": 929,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2023-12-03T04:06:04",
      "ExpirationDate": "2025-06-30T04:27:29",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "trial",
      "ItemHierarchyId": 1,
      "ItemHierarchyName": "primary",
      "LicenseStatusId": 0,
      "LicenseStatusDescription": "inactive",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    }
  },
  "Customer": {
    "VendorCustomerCode": "35118",
    "CompanyName": "Sample Company"
  }
}                    
<GetProductLicenseResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <ChildLicenseActivations>9</ChildLicenseActivations>
  <Customer>
    <CompanyName>Sample Company</CompanyName>
    <VendorCustomerCode>35118</VendorCustomerCode>
  </Customer>
  <Keycode>D41A6B3BCC094B41963F</Keycode>
  <LicenseId>197027008</LicenseId>
  <ParentKeycode>CB43F7FC84814893AD7C</ParentKeycode>
  <ParentLicenseId>157701103</ParentLicenseId>
  <PartnerStartDate>2021-09-23T00:49:02</PartnerStartDate>
  <ProductLineDescription>Webroot Business</ProductLineDescription>
  <Profile xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SAEP</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>trial</CategoryTypeName>
        <ExpirationDate>2025-06-30T04:27:29</ExpirationDate>
        <ItemHierarchyId>1</ItemHierarchyId>
        <ItemHierarchyName>primary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot Endpoint Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SAEP</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>929</LicenseSeats>
        <LicenseStatusDescription>inactive</LicenseStatusDescription>
        <LicenseStatusId>0</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2023-12-03T04:06:04</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
  </Profile>
</GetProductLicenseResponseServiceModel>