GET /service/api/ecom/shop/products/{keycode}
Gets a license by its keycode.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
keycode |
The product keycode. |
string |
Required |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/ecom/shop/products/02F2C28AF13848DE85A8
|
Body Parameters
None.
Response Information
Resource Description
The license which represents a set of subscriptions to particular products.
GetProductLicenseResponseServiceModelName | Description | Type | Additional 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. |
CustomAttribute |
Custom value which may be set by eCom depending on the use case. |
string |
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": 149071582, "Keycode": "B4B350BB76F848B690C7", "ProductLineDescription": "Webroot Business", "ParentLicenseId": 112694130, "ParentKeycode": "5684C1E2A1554A85876C", "ChildLicenseActivations": 6, "PartnerStartDate": "2024-05-11T13:20:20", "CustomAttribute": null, "Profile": { "SAEP": { "LicenseCategoryName": "SAEP", "LicenseCategoryDescription": "Webroot Endpoint Protection", "LicenseSeats": 619, "LicenseKeycodeTypeId": 3, "StartDate": "2024-10-20T09:23:17", "ExpirationDate": "2027-01-17T11:21:41", "LicenseAttributeValue": null, "LicenseAttributeValueDescription": null, "LicenseAttributeDescription": null, "CategoryTypeName": "trial", "ItemHierarchyId": 1, "ItemHierarchyName": "primary", "LicenseStatusId": 2, "LicenseStatusDescription": "disabled", "UsagePricingModelId": null, "UsagePricingModelName": null, "UsageCheckDay": 15, "VaultId": null, "VaultName": null, "Vaults": null, "ProductPlatformId": null, "ProductPlatformName": null, "RetentionModelId": null, "RetentionModelName": null }, "SDNS": { "LicenseCategoryName": "SDNS", "LicenseCategoryDescription": "Webroot DNS Protection", "LicenseSeats": 942, "LicenseKeycodeTypeId": 3, "StartDate": "2023-05-02T12:34:33", "ExpirationDate": "2027-03-05T00:48:12", "LicenseAttributeValue": null, "LicenseAttributeValueDescription": null, "LicenseAttributeDescription": null, "CategoryTypeName": "full", "ItemHierarchyId": 2, "ItemHierarchyName": "secondary", "LicenseStatusId": 0, "LicenseStatusDescription": "inactive", "UsagePricingModelId": null, "UsagePricingModelName": null, "UsageCheckDay": 15, "VaultId": null, "VaultName": null, "Vaults": null, "ProductPlatformId": null, "ProductPlatformName": null, "RetentionModelId": null, "RetentionModelName": null }, "SECA": { "LicenseCategoryName": "SECA", "LicenseCategoryDescription": "Webroot Security Awareness", "LicenseSeats": 385, "LicenseKeycodeTypeId": 3, "StartDate": "2022-10-23T05:42:58", "ExpirationDate": "2027-07-02T12:00:44", "LicenseAttributeValue": null, "LicenseAttributeValueDescription": null, "LicenseAttributeDescription": null, "CategoryTypeName": "full", "ItemHierarchyId": 2, "ItemHierarchyName": "secondary", "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": "83977", "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>6</ChildLicenseActivations> <CustomAttribute i:nil="true" /> <Customer> <CompanyName>Sample Company</CompanyName> <VendorCustomerCode>83977</VendorCustomerCode> </Customer> <Keycode>B4B350BB76F848B690C7</Keycode> <LicenseId>149071582</LicenseId> <ParentKeycode>5684C1E2A1554A85876C</ParentKeycode> <ParentLicenseId>112694130</ParentLicenseId> <PartnerStartDate>2024-05-11T13:20:20</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>2027-01-17T11:21:41</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>619</LicenseSeats> <LicenseStatusDescription>disabled</LicenseStatusDescription> <LicenseStatusId>2</LicenseStatusId> <ProductPlatformId i:nil="true" /> <ProductPlatformName i:nil="true" /> <RetentionModelId i:nil="true" /> <RetentionModelName i:nil="true" /> <StartDate>2024-10-20T09:23:17</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> <d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK> <d2p1:Key>SDNS</d2p1:Key> <d2p1:Value> <CategoryTypeName>full</CategoryTypeName> <ExpirationDate>2027-03-05T00:48:12</ExpirationDate> <ItemHierarchyId>2</ItemHierarchyId> <ItemHierarchyName>secondary</ItemHierarchyName> <LicenseAttributeDescription i:nil="true" /> <LicenseAttributeValue i:nil="true" /> <LicenseAttributeValueDescription i:nil="true" /> <LicenseCategoryDescription>Webroot DNS Protection</LicenseCategoryDescription> <LicenseCategoryName>SDNS</LicenseCategoryName> <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId> <LicenseSeats>942</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-05-02T12:34:33</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> <d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK> <d2p1:Key>SECA</d2p1:Key> <d2p1:Value> <CategoryTypeName>full</CategoryTypeName> <ExpirationDate>2027-07-02T12:00:44</ExpirationDate> <ItemHierarchyId>2</ItemHierarchyId> <ItemHierarchyName>secondary</ItemHierarchyName> <LicenseAttributeDescription i:nil="true" /> <LicenseAttributeValue i:nil="true" /> <LicenseAttributeValueDescription i:nil="true" /> <LicenseCategoryDescription>Webroot Security Awareness</LicenseCategoryDescription> <LicenseCategoryName>SECA</LicenseCategoryName> <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId> <LicenseSeats>385</LicenseSeats> <LicenseStatusDescription>inactive</LicenseStatusDescription> <LicenseStatusId>0</LicenseStatusId> <ProductPlatformId i:nil="true" /> <ProductPlatformName i:nil="true" /> <RetentionModelId i:nil="true" /> <RetentionModelName i:nil="true" /> <StartDate>2022-10-23T05:42:58</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>