POST /service/api/ecom/shop/trials/{keycode}/modules
Creates trial modules for a given parent keycode.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
keycode |
The keycode of a parent console where trial module(s) should be created. |
string |
Required |
URI Sample(s)
POST
|
https://unityapi.webrootcloudav.com/service/api/ecom/shop/trials/737B67CFA37B4011B579/modules
|
Body Parameters
Information about the trial(s) that should be created.
CreateModuleTrialRequestServiceModelName | Description | Type | Additional Information |
---|---|---|---|
Modules |
Modules (e.g. DNS Protection or WSAT) for which trial licenses should be created. |
Collection of CreateModuleTrialRequestServiceModel_Module |
Required |
Sample Request
{ "Modules": [ { "LicenseSeats": 447, "LicenseCategoryName": "SDNS", "VaultId": null, "ProductPlatformId": null }, { "LicenseSeats": 297, "LicenseCategoryName": "SECA", "VaultId": null, "ProductPlatformId": null } ] }
<CreateModuleTrialRequestServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models"> <Modules> <CreateModuleTrialRequestServiceModel_Module> <LicenseCategoryName>SDNS</LicenseCategoryName> <LicenseSeats>447</LicenseSeats> <ProductPlatformId i:nil="true" /> <VaultId i:nil="true" /> </CreateModuleTrialRequestServiceModel_Module> <CreateModuleTrialRequestServiceModel_Module> <LicenseCategoryName>SECA</LicenseCategoryName> <LicenseSeats>297</LicenseSeats> <ProductPlatformId i:nil="true" /> <VaultId i:nil="true" /> </CreateModuleTrialRequestServiceModel_Module> </Modules> </CreateModuleTrialRequestServiceModel>
Response Information
Resource Description
Details about the newly created trial(s).
CreateModuleTrialResponseServiceModelName | 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. |
Profile |
A dictionary of profiles. |
Dictionary of string [key] and CreateModuleTrialResponseServiceModel_LicenseProfile [value] |
None. |
Customer |
The customer associated to this license. |
CreateModuleTrialResponseServiceModel_Customer |
None. |
Sample Response
{ "LicenseId": 124966936, "Keycode": "F6663B41FE7744628AFA", "ProductLineDescription": "Webroot Business", "ParentLicenseId": 137033728, "ParentKeycode": "D46C1B5897E04832AD7A", "ChildLicenseActivations": 7, "PartnerStartDate": "2024-07-09T02:10:59", "Profile": { "SAEP": { "LicenseCategoryName": "SAEP", "LicenseCategoryDescription": "Webroot Endpoint Protection", "LicenseSeats": 317, "LicenseKeycodeTypeId": 3, "StartDate": "2023-10-03T14:18:13", "ExpirationDate": "2027-08-02T02:37:49", "LicenseAttributeValue": null, "LicenseAttributeValueDescription": null, "LicenseAttributeDescription": null, "CategoryTypeName": "trial", "ItemHierarchyId": 1, "ItemHierarchyName": "primary", "LicenseStatusId": 3, "LicenseStatusDescription": "manually 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": 85, "LicenseKeycodeTypeId": 3, "StartDate": "2023-09-21T01:09:34", "ExpirationDate": "2026-11-28T07:00:20", "LicenseAttributeValue": null, "LicenseAttributeValueDescription": null, "LicenseAttributeDescription": null, "CategoryTypeName": "trial", "ItemHierarchyId": 2, "ItemHierarchyName": "secondary", "LicenseStatusId": 2, "LicenseStatusDescription": "disabled", "UsagePricingModelId": null, "UsagePricingModelName": null, "UsageCheckDay": 15, "VaultId": null, "VaultName": null, "Vaults": null, "ProductPlatformId": null, "ProductPlatformName": null, "RetentionModelId": null, "RetentionModelName": null } }, "Customer": { "VendorCustomerCode": "48425" } }
<CreateModuleTrialResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models"> <ChildLicenseActivations>7</ChildLicenseActivations> <Customer> <VendorCustomerCode>48425</VendorCustomerCode> </Customer> <Keycode>F6663B41FE7744628AFA</Keycode> <LicenseId>124966936</LicenseId> <ParentKeycode>D46C1B5897E04832AD7A</ParentKeycode> <ParentLicenseId>137033728</ParentLicenseId> <PartnerStartDate>2024-07-09T02:10:59</PartnerStartDate> <ProductLineDescription>Webroot Business</ProductLineDescription> <Profile xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK> <d2p1:Key>SAEP</d2p1:Key> <d2p1:Value> <CategoryTypeName>trial</CategoryTypeName> <ExpirationDate>2027-08-02T02:37:49</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>317</LicenseSeats> <LicenseStatusDescription>manually disabled</LicenseStatusDescription> <LicenseStatusId>3</LicenseStatusId> <ProductPlatformId i:nil="true" /> <ProductPlatformName i:nil="true" /> <RetentionModelId i:nil="true" /> <RetentionModelName i:nil="true" /> <StartDate>2023-10-03T14:18:13</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:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK> <d2p1:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK> <d2p1:Key>SDNS</d2p1:Key> <d2p1:Value> <CategoryTypeName>trial</CategoryTypeName> <ExpirationDate>2026-11-28T07:00:20</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>85</LicenseSeats> <LicenseStatusDescription>disabled</LicenseStatusDescription> <LicenseStatusId>2</LicenseStatusId> <ProductPlatformId i:nil="true" /> <ProductPlatformName i:nil="true" /> <RetentionModelId i:nil="true" /> <RetentionModelName i:nil="true" /> <StartDate>2023-09-21T01:09:34</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:KeyValueOfstringCreateModuleTrialResponseServiceModel_LicenseProfilefLvholdK> </Profile> </CreateModuleTrialResponseServiceModel>