Element: returnLicenseResponse

Description

A returnLicenseResponse message contains an element of returnFulfillmentResponseType.

Each fulfillment in the returnLicenseRequest is returned as an atomic unit; returning each either succeeds or fails.

Derived By

Type returnFulfillmentResponseType

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.

responseData

returnResponseDataType

0..1

Information about the fulfillments that were returned is listed in the responseData element. For returnLicense, this data is only populated in the case of a partial return, not a successful one. See returnResponseDataType.

failedData

failedReturnResponselistDataType

0..1

Information about the fulfillments that were not returned is listed in the failedData element. See failedReturnResponselistDataType.

Referenced By

Name	Type
returnLicense	Method

XML Example

The following XML fragment illustrates a successful returnLicenseResponse message:

<returnLicenseResponse xmlns="urn:com.macrovision:flexnet/operations">
   <statusInfo>
      <status>SUCCESS</status>
   </statusInfo>
   <responseData>
      <fulfillmentData>
         <recordRefNo>1</recordRefNo>
         <fulfillment>
            <entitlementIdentifier>
               <uniqueId>HID-1</uniqueId>
               <primaryKeys>
                  <entitlementId>se1</entitlementId>
               </primaryKeys>
            </entitlementIdentifier>
            <fulfillmentIdentifier>
               <uniqueId>HID-4</uniqueId>
               <primaryKeys>
                  <fulfillmentId>FID_fabb1487_940d_4c4f_9e66_d468cace5bb7</fulfillmentId>
               </primaryKeys>
            </fulfillmentIdentifier>
            <fulfillmentType>CERTIFICATE</fulfillmentType>
            <lineItem>
               <uniqueId>HID-1</uniqueId>
               <primaryKeys>
                  <activationId>se1-1</activationId>
               </primaryKeys>
            </lineItem>
            <product>
               <uniqueId>HID-1</uniqueId>
               <primaryKeys>
                  <name>P1</name>
                  <version>1.0</version>
               </primaryKeys>
            </product>
            <soldTo>O1</soldTo>
            <shipToEmail/>
            <shipToAddress/>
            <serverIds>
               <server1>DISPLAY=test</server1>
            </serverIds>
            <fulfilledCount>2</fulfilledCount>
            <overDraftCount>0</overDraftCount>
            <fulfillDate>2015-10-01</fulfillDate>
            <fulfillDateTime>2015-10-01T21:57:23.238Z</fulfillDateTime>
            <isPermanent>false</isPermanent>
            <startDate>2015-10-01</startDate>
            <expirationDate>2015-10-30</expirationDate>
            <licenseText>SERVER this_host DISPLAY=test
VENDOR demo
USE_SERVER
INCREMENT f1 demo 1.0 30-oct-2015 2 ISSUER="My Corporation" \
          ISSUED=1-oct-2015 START=30-sep-2015 SIGN="002A 4DB7 4541 C283 \
          8C82 F10A 5F6C 3B00 AAE3 3CC2 9203 8367 FA9F 05A8 1D06"</licenseText>
            <consolidatedHostLicense>
               <license>#Please Do not delete this comment line.
SERVER this_host DISPLAY=test
VENDOR demo
USE_SERVER
INCREMENT f1 demo 1.0 30-oct-2015 2 ISSUER="My Corporation" \
          ISSUED=1-oct-2015 START=30-sep-2015 SIGN="002A 4DB7 4541 C283 \
          8C82 F10A 5F6C 3B00 AAE3 3CC2 9203 8367 FA9F 05A8 1D06"</license>
            </consolidatedHostLicense>
            <supportAction>MASTER</supportAction>
            <lastModifiedDateTime>2015-10-01T21:57:23.280Z</lastModifiedDateTime>
            <parentFulfillmentId>
               <uniqueId>HID-3</uniqueId>
               <primaryKeys>
                  <fulfillmentId>FID_f614ad8f_c508_4648_aeaa_29e18babc3a8</fulfillmentId>
               </primaryKeys>
            </parentFulfillmentId>
            <licenseTechnology>
               <uniqueId>HID-2</uniqueId>
               <primaryKeys>
                  <name>FlexNet Licensing</name>
               </primaryKeys>
            </licenseTechnology>
            <licenseModelAttributes>
               <attribute>
                 <attributeName>ISSUER</attributeName>
                  <stringValue>My Corporation</stringValue>
               </attribute>
               <attribute>
                  <attributeName>INCLUDE_USE_SERVER</attributeName>
                  <booleanValue>true</booleanValue>
               </attribute>
               <attribute>
                  <attributeName>ALLOW_ONE_TERMINAL_SERVER</attributeName>
                  <booleanValue>false</booleanValue>
               </attribute>
               <attribute>
                  <attributeName>NOTICE</attributeName>
               </attribute>
               <attribute>
                  <attributeName>SERIAL_NUMBER</attributeName>
               </attribute>
               <attribute>
                  <attributeName>VENDOR_STRING</attributeName>
               </attribute>
            </licenseModelAttributes>
            <state>ACTIVE</state>
            <fulfillmentSource>ONLINE</fulfillmentSource>
            <licenseFiles>
               <licenseFile>
                  <licenseFileDefinitionName>FNP License</licenseFileDefinitionName>
                  <licenseText>SERVER this_host DISPLAY=test
VENDOR demo
USE_SERVER
INCREMENT f1 demo 1.0 30-oct-2015 2 ISSUER="My Corporation" \
          ISSUED=1-oct-2015 START=30-sep-2015 SIGN="002A 4DB7 4541 C283 \
          8C82 F10A 5F6C 3B00 AAE3 3CC2 9203 8367 FA9F 05A8 1D06"</licenseText>
               </licenseFile>
            </licenseFiles>
            <entitledProducts>
               <entitledProduct>
                  <product>
                     <uniqueId>HID-1</uniqueId>
                     <primaryKeys>
                        <name>P1</name>
                        <version>1.0</version>
                     </primaryKeys>
                  </product>
                  <quantity>1</quantity>
               </entitledProduct>
            </entitledProducts>
            <activationType>DEFAULT</activationType>
         </fulfillment>
      </fulfillmentData>
   </responseData>
</returnLicenseResponse>