POST /service/api/ecom/shop/trials/{keycode}/modules

Creates trial modules for a given parent keycode.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/7544F7F8C25246849171/modules

Body Parameters

Information about the trial(s) that should be created.

CreateModuleTrialRequestServiceModel
NameDescriptionTypeAdditional 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": 988,
      "LicenseCategoryName": "SDNS",
      "VaultId": null,
      "ProductPlatformId": null
    },
    {
      "LicenseSeats": 682,
      "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>988</LicenseSeats>
      <ProductPlatformId i:nil="true" />
      <VaultId i:nil="true" />
    </CreateModuleTrialRequestServiceModel_Module>
    <CreateModuleTrialRequestServiceModel_Module>
      <LicenseCategoryName>SECA</LicenseCategoryName>
      <LicenseSeats>682</LicenseSeats>
      <ProductPlatformId i:nil="true" />
      <VaultId i:nil="true" />
    </CreateModuleTrialRequestServiceModel_Module>
  </Modules>
</CreateModuleTrialRequestServiceModel>

Response Information

Resource Description

Details about the newly created trial(s).

CreateModuleTrialResponseServiceModel
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 CreateModuleTrialResponseServiceModel_LicenseProfile [value]

None.
Customer

The customer associated to this license.

 CreateModuleTrialResponseServiceModel_Customer

None.

Sample Response

{
  "LicenseId": 154745416,
  "Keycode": "C85DA1D562474019AEDE",
  "ProductLineDescription": "Webroot Business",
  "ParentLicenseId": 198019546,
  "ParentKeycode": "6174B45958DA4A258EA3",
  "ChildLicenseActivations": 7,
  "PartnerStartDate": "2023-06-16T21:22:30",
  "Profile": {
    "SAEP": {
      "LicenseCategoryName": "SAEP",
      "LicenseCategoryDescription": "Webroot Endpoint Protection",
      "LicenseSeats": 305,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2022-10-19T10:52:01",
      "ExpirationDate": "2026-03-13T13:46:04",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "full",
      "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": 811,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2024-04-09T16:13:26",
      "ExpirationDate": "2027-03-30T10:33:41",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "full",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "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
    },
    "SECA": {
      "LicenseCategoryName": "SECA",
      "LicenseCategoryDescription": "Webroot Security Awareness",
      "LicenseSeats": 167,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2023-10-18T21:15:42",
      "ExpirationDate": "2026-11-12T06:48:20",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "trial",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "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
    }
  },
  "Customer": {
    "VendorCustomerCode": "78856"
  }
}                    
<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>78856</VendorCustomerCode>
  </Customer>
  <Keycode>C85DA1D562474019AEDE</Keycode>
  <LicenseId>154745416</LicenseId>
  <ParentKeycode>6174B45958DA4A258EA3</ParentKeycode>
  <ParentLicenseId>198019546</ParentLicenseId>
  <PartnerStartDate>2023-06-16T21:22:30</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>full</CategoryTypeName>
        <ExpirationDate>2026-03-13T13:46:04</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>305</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>2022-10-19T10:52:01</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>full</CategoryTypeName>
        <ExpirationDate>2027-03-30T10:33:41</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>811</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>2024-04-09T16:13:26</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>SECA</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>trial</CategoryTypeName>
        <ExpirationDate>2026-11-12T06:48:20</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>167</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-18T21:15:42</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>