Cisco Unity Connection Provisioning Interface (CUPI) API -- License Dump APIs

From DocWiki

Revision as of 06:18, 11 September 2013 by Subabhat (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


License Dump APIs

Administrator can use this API to fetch license usage information for 5 licensing parameters/features. These 5 license parameters are:

License Parameter License Tag Feature Description
CUC_BasicMessaging LicSubscribersMax Total number of voicemail users Specifies the maximum number of voice mail users configured in Cisco Unity Connection.

Note: All the users which are created at the time of installation. For example, "operator" and "undeliverablemessagesmailbox" are removed from this count. Also all the tenant operator user count is not included in the count for this tag.

CUC_SpeechView LicSTTSubscribersMax Total number of speech view users using the standard transcription services Specifies the maximum number of speech view users using the standard transcription services configured in Cisco Unity Connection.
CUC_SpeechViewPro LicSTTProSubscribersMax Total number of speech view users using the professional transcription services Specifies the maximum number of Speech view users using the professional transcription services configured in Cisco Unity Connection
CUC_SpeechConnectPort LicRealspeakSessionsMax Total number of speech connect ports Specifies the maximum number of Speech Connect calls configured in Cisco Unity Connection
CUC_EnhancedMessaging LicSrsvCuceSubscribersMax Total number of enhanced messaging users Specifies the maximum number of Connection SRSV users configured on Cisco Unity Connection. The Connection SRSV users are reflected under this tag only when the branch is active. This feature is not applicable for Tenant Partitioning system.


Listing the License Status Count

The following is an example of the GET request that lists all the license status count:

  GET https://<connection-server>/vmrest/licensestatuscounts

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

<LicenseStatusCounts total="5">
  <LicenseStatusCount>
    <URI>/vmrest/licensestatuscounts/LicSubscribersMax</URI>
    <TagName>LicSubscribersMax</TagName>
    <ObjectId>bc1f1f5d-f628-4bca-b0c9-f225d07d677f</ObjectId>
    <Count>3</Count>
    <featureName>CUC_BasicMessaging</featureName>
    <description>Total Number of Voicemail users</description>
  </LicenseStatusCount>
  <LicenseStatusCount>
    <URI>/vmrest/licensestatuscounts/LicSrsvCuceSubscribersMax</URI>
    <TagName>LicSrsvCuceSubscribersMax</TagName>
    <ObjectId>99541ef5-4602-424c-84e6-6c9fe8b4044b</ObjectId>
    <Count>0</Count>
    <featureName>CUC_EnhancedMessaging</featureName>
    <description>Total Number of Enhanced Messaging Users</description>
  </LicenseStatusCount>
  <LicenseStatusCount>
    <URI>/vmrest/licensestatuscounts/LicSTTSubscribersMax</URI>
    <TagName>LicSTTSubscribersMax</TagName>
    <ObjectId>dfbaf0f8-38b0-4e14-9f62-9b1e59cc2426</ObjectId>
    <Count>0</Count>
    <featureName>CUC_SpeechView</featureName>
    <description>Speechview Standard users</description>
  </LicenseStatusCount> 
  <LicenseStatusCount>
    <URI>/vmrest/licensestatuscounts/LicSTTProSubscribersMax</URI>
    <TagName>LicSTTProSubscribersMax</TagName>
    <ObjectId>d1f15aa9-2482-4a80-93e8-58fb402e31dd</ObjectId>
    <Count>3</Count>
    <featureName>CUC_SpeechViewPro</featureName>
    <description>Speechview Professional Users</description>
  </LicenseStatusCount> 
  <LicenseStatusCount>
    <URI>/vmrest/licensestatuscounts/LicRealspeakSessionsMax</URI>
    <TagName>LicRealspeakSessionsMax</TagName>
    <ObjectId>2b1a7da9-6b13-4302-8efd-91db94b2c241</ObjectId>
    <Count>3</Count>
    <featureName>CUC_SpeechConnectPort</featureName>
    <description>Total Number of speech connect sessions</description>
  </LicenseStatusCount>
</LicenseStatusCounts>
<pre>
Response Code: 200

JSON Example

To list all the license status count use the following command:

Request URI:
GET https://<connection-server>/vmrest/licensestatuscounts
Accept: application /json
Connection: keep-alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
  "@total":"2"
  "LicenseStatusCount":[
  {
    "URI":"/vmrest/licensestatuscounts/LicSubscribersMax"
    "TagName":"LicSubscribersMax"
    "ObjectId":"bc1f1f5d-f628-4bca-b0c9-f225d07d677f"
    "Count":"3"
    "featureName":"CUC_BasicMessaging"
    "description":"Total Number of Voicemail users"
  }
  {
    "URI":"/vmrest/licensestatuscounts/LicSrsvCuceSubscribersMax"
    "TagName":"LicSrsvCuceSubscribersMax"
    "ObjectId":"99541ef5-4602-424c-84e6-6c9fe8b4044b"
    "Count":"0"
    "featureName":"CUC_EnhancedMessaging"
    "description":"Total Number of Enhanced Messaging Users"
  }
  ]
}
Response Code: 200


Viewing the Specific License Status Count

Request URI:
  GET https://<connection-server>/vmrest/licensestatuscounts/<TagName>

Tag names can be:

  • LicSubscribersMax
  • LicSrsvCuceSubscribersMax
  • LicSTTSubscribersMax
  • LicSTTProSubscribersMax
  • LicRealspeakSessionsMaxSample Request

The following is an example of the GET request that lists the details of specific license status count represented by the provided value of object ID:

GET https://<connection-server>/vmrest/licensestatuscounts/LicSubscribersMax

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

<LicenseStatusCount>
    <URI>/vmrest/licensestatuscounts/LicSubscribersMax</URI>
    <TagName>LicSubscribersMax</TagName>
    <ObjectId>bc1f1f5d-f628-4bca-b0c9-f225d07d677f</ObjectId>
    <Count>3</Count>
    <featureName>CUC_BasicMessaging</featureName>
    <description>Total Number of Voicemail users</description>
</LicenseStatusCount>
Response Code: 200

JSON Example

To view specific license status count, do the following:

GET https://<connection-server>/vmrest/licensestatuscounts/<TagName>
Request URI:
GET https://<connection-server>/vmrest/licensestatuscounts/LicSubscribersMax
Accept: application /json
Connection: keep-alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
    "URI":"/vmrest/licensestatuscounts/LicSubscribersMax"
    "TagName":"LicSubscribersMax"
    "ObjectId":"bc1f1f5d-f628-4bca-b0c9-f225d07d677f"
    "Count":"3"
    "featureName":"CUC_BasicMessaging"
    "description":"Total  Number of Voicemail users"
}
Response Code: 200


Explanation of Data Fields

The following chart lists all of the data fields:

Parameter Operation Data Type Comment
URI Read Only String Specifies the URI of the API.
TagName Read Only String Specifies the license tag of the feature.

Tag names can be:

  • LicSubscribersMax
  • LicSrsvCuceSubscribersMax
  • LicSTTSubscribersMax
  • LicSTTProSubscribersMax
  • LicRealspeakSessionsMax
ObjectId Read Only String(36) Identifier for a LicenseStatus object.
Count Read Only Integer The current usage of the feature in the system. It is a number specifying the current usage count or if the feature is in use.
featureName Read Only String The name of the feature.
Description Read Only String The description of the feature.

Rating: 0.0/5 (0 votes cast)

Personal tools