FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Element: tns:upgradeLicenseResponse

Description

An upgradeLicenseResponse message contains an element of EntitlementLifeCycleResponseType.

Each entitlement in the upgradeLicenseRequest is renewed as an atomic unit; upgrading each either succeeds or fails.

Derived By

Type EntitlementLifeCycleResponseType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
statusInfo  StatusInfoType  1..1 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All entitlements in the request were processed.

  • PARTIAL_FAILURE—Some, but not all entitlements in the request were processed.

  • FAILURE—None of the entitlements in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
failedData  failedEntitlementLifeCycleDataListType  0..1  Information about the entitlements that were not upgraded is listed in the failedData element. See failedEntitlementLifeCycleDataListType.
responseData  createdEntitlementLifeCycleDataListType  0..1  Information about the entitlements that were upgraded is listed in the responseData element. See createdEntitlementLifeCycleDataListType.
Referenced By
Name  Type 
upgradeLicense  Method 
XML Example

The following XML fragment illustrates a successful upgradeLicenseResponse message:

<upgradeLicenseResponse>
   <statusInfo>
      <status>SUCCESS</status>
   </statusInfo>
   <responseData>
      <entitlementData>
         <entitlementRecordRefNo>01</entitlementRecordRefNo>
         <parentEntitlementIdentifier>
            <primaryKeys>
               <entitlementId>Ent-upgrade</entitlementId>
            </primaryKeys>
         </parentEntitlementIdentifier>
         <createdLineItemData>
            <lineItemRecordRefNo>01</lineItemRecordRefNo>
            <parentLineItemIdentifier>
               <primaryKeys>
                  <activationId>Ent-upgrade-1</activationId>
               </primaryKeys>
            </parentLineItemIdentifier>
            <newLineItem>
               <uniqueId>HID-220134</uniqueId>
               <activationId>Ent-upgrade-1UPGRADE</activationId>
            </newLineItem>
         </createdLineItemData>
      </entitlementData>
   </responseData>
</upgradeLicenseResponse>