Skip to content

Commit

Permalink
Add "timeVolumePeriod" wiki documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
r-brown committed Jan 11, 2024
1 parent 3fa2afc commit fde0a17
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
20 changes: 11 additions & 9 deletions docs/restful-api/services/license-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,17 +202,18 @@ Content-Type: application/x-www-form-urlencoded</p></td>
</tr>
<tr class="even">
<td><p>Request Parameters</p></td>
<td><p><span style="color: rgb(0,0,0);">licenseeNumber (string) - <span>licenseeNumber</span></span> to assign new license object.</p>
<p><span style="color: rgb(0,0,0);">licenseTemplateNumber (string) - <span>licenseTemplateNumber</span></span> to assign new license object.<span style="color: rgb(0,0,0);"> </span></p>
<td><p>licenseeNumber (string) - <span>licenseeNumber</span> to assign new license object.</p>
<p>licenseTemplateNumber (string) - <span>licenseTemplateNumber</span> to assign new license object. </p>
<p>number (string) - Unique number (across all products/licensees of a vendor) that identifies the license. Vendor can assign this number when creating a license or let NetLicensing generate one. Read-only after corresponding creation transaction status is set to closed.</p>
<p>active (boolean) - If set to false, the license is disabled. License can be re-enabled, but as long as it is disabled, the license is excluded from the validation process.</p>
<p>name (string) - Name for the licensed item. Set from license template on creation, if not specified explicitly. Optional.</p>
<p>price (<span style="color: rgb(0,0,0);">double</span>) - price for the license. If &gt;0, it must always be accompanied by the currency specification. Read-only, set from license template on creation. Optional.</p>
<p>price (double) - price for the license. If &gt;0, it must always be accompanied by the currency specification. Read-only, set from license template on creation. Optional.</p>
<p>currency (enum) - specifies currency for the license price. Check data types to discover which currencies are supported. Read-only, set from license template on creation. Optional.</p>
<p>- EUR       - Euro currency for the license price</p>
<p>hidden (boolean) - If set to 'true', this license is not shown in <a href="netlicensing-shop">NetLicensing Shop</a> as purchased license. Set from license template on creation, if not specified explicitly. Optional.</p>
<p><span style="color: rgb(0,0,0);">parentfeature (string) - Mandatory for 'TIMEVOLUME' license type and 'RENTAL' licensing model. Optional.</span></p>
<p><span style="color: rgb(0,0,0);">timeVolume (string) - Mandatory for 'TIMEVOLUME' license type. Optional.</span></p></td>
<p>parentfeature (string) - Mandatory for 'TIMEVOLUME' license type and 'RENTAL' licensing model. Optional.</p>
<p>timeVolume (number) - Mandatory for 'TIMEVOLUME' license type.</p></td>
<p>timeVolumePeriod (string) - indicates the time unit for the 'timeVolume' parameter; allowed values - DAY, WEEK, MONTH, YEAR</p></td>
</tr>
<tr class="odd">
<td><p>HTTP Status Code</p></td>
Expand Down Expand Up @@ -293,10 +294,11 @@ Content-Type: application/x-www-form-urlencoded</p></td>
<p>number (string) - Unique number (across all products/licensees of a vendor) that identifies the license. Vendor can assign this number when creating a license or let NetLicensing generate one. Read-only after corresponding creation transaction status is set to closed. Optional.</p>
<p>active (boolean) - If set to false, the license is disabled. License can be re-enabled, but as long as it is disabled, the license is excluded from the validation process. Optional.</p>
<p>name (string) - Name for the licensed item. Set from license template on creation, if not specified explicitly. Optional.</p>
<p><span style="color: rgb(0,0,0);">startDate (<span>date-time</span>) - for TIMEVOLUME licenseType</span></p>
<p><span style="color: rgb(0,0,0);">parentfeature (string) - Mandatory for 'TIMEVOLUME' license type and 'RENTAL' licensing model. Optional.</span></p>
<p><span style="color: rgb(0,0,0);">timeVolume (string) - Mandatory for 'TIMEVOLUME' license type. Optional.</span></p>
<p>price (<span style="color: rgb(0,0,0);">double</span>) - price for the license. If &gt;0, it must always be accompanied by the currency specification. Read-only, set from license template on creation. Optional.</p>
<p>startDate (<span>date-time</span>) - for TIMEVOLUME licenseType</p>
<p>parentfeature (string) - Mandatory for 'TIMEVOLUME' license type and 'RENTAL' licensing model. Optional.</p>
<p>timeVolume (number) - Mandatory for 'TIMEVOLUME' license type.</p></td>
<p>timeVolumePeriod (string) - indicates the time unit for the 'timeVolume' parameter; allowed values - DAY, WEEK, MONTH, YEAR</p></td>
<p>price (double) - price for the license. If &gt;0, it must always be accompanied by the currency specification. Read-only, set from license template on creation. Optional.</p>
<p>currency (enum) - specifies currency for the license price. Check data types to discover which currencies are supported. Read-only, set from license template on creation. Optional.</p>
<p>- EUR       - Euro currency for the license price</p>
<p>hidden (boolean) - If set to 'true', this license is not shown in <a href="netlicensing-shop">NetLicensing Shop</a> as purchased license. Set from license template on creation, if not specified explicitly. Optional.</p></td>
Expand Down
6 changes: 4 additions & 2 deletions docs/restful-api/services/license-template-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ Content-Type: application/x-www-form-urlencoded</p></td>
<p><span style="color: rgb(0,0,0);">name (string) - L</span>icense template name to create license template object.</p>
<p><span style="color: rgb(0,0,0);"><span>active (boolean) - If set to 'false', the license template is disabled. Licensee can not obtain any new licenses off this license template.</span> </span></p>
<p>licenseType (<span style="color: rgb(0,0,0);">Array[string]</span>) - Type of licenses created from this license template. Supported types: "FEATURE", "TIMEVOLUME", "FLOATING", "QUANTITY".</p>
<p><span style="color: rgb(0,0,0);">timeVolume <span>(string) </span>- Mandatory for 'TIMEVOLUME' license type. </span></p>
<p><span style="color: rgb(0,0,0);">timeVolume <span>(number) </span>- Mandatory for 'TIMEVOLUME' license type. </span></p>
<p>timeVolumePeriod (string) - indicates the time unit for the 'timeVolume' parameter; allowed values - DAY, WEEK, MONTH, YEAR</p></td>
<p><span style="color: rgb(0,0,0);">maxSessions <span>(string) </span>- Mandatory for 'FLOATING' license type.</span></p>
<p><span style="color: rgb(0,0,0);">quantity (<span>string</span>) - </span><span style="color: rgb(0,0,0);">Mandatory for 'QUANTITY' license type.</span></p>
<p><span style="color: rgb(0,0,0);">price (<span>double</span>) - Price for the license. If &gt;0, it must always be accompanied by the currency specification. Optional.</span><span style="color: rgb(0,0,0);"> </span></p>
Expand Down Expand Up @@ -300,7 +301,8 @@ Content-Type: application/x-www-form-urlencoded</p></td>
<p><span style="color: rgb(0,0,0);">name (string) - L</span>icense template name to create license template object.</p>
<p><span style="color: rgb(0,0,0);">active (boolean) - If set to 'false', the license template is disabled. Licensee can not obtain any new licenses off this license template. </span></p>
<p>licenseType (<span style="color: rgb(0,0,0);">Array[string]</span>) - Type of licenses created from this license template. Supported types: "FEATURE", "TIMEVOLUME", "FLOATING", "QUANTITY".</p>
<p><span style="color: rgb(0,0,0);">timeVolume (string) - Mandatory for 'TIMEVOLUME' license type. </span></p>
<p><span style="color: rgb(0,0,0);">timeVolume (bumber) - Mandatory for 'TIMEVOLUME' license type. </span></p>
<p>timeVolumePeriod (string) - indicates the time unit for the 'timeVolume' parameter; allowed values - DAY, WEEK, MONTH, YEAR</p></td>
<p><span style="color: rgb(0,0,0);">maxSessions (string) - Mandatory for 'FLOATING' license type.</span></p>
<p><span style="color: rgb(0,0,0);">quantity (string) - </span><span style="color: rgb(0,0,0);">Mandatory for 'QUANTITY' license type.</span></p>
<p><span style="color: rgb(0,0,0);">price (double) - Price for the license. If &gt;0, it must always be accompanied by the currency specification. Optional.</span><span style="color: rgb(0,0,0);"> </span></p>
Expand Down

0 comments on commit fde0a17

Please sign in to comment.