FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Element: tns:searchEntitlementResponse

Description

A searchEntitlementResponse message contains an element of searchEntitlementResponseType.

Note:The soldTo element is supported for backwards compatibility in the response to this operation, and now the channelPartners element is also supported. Note, however, that the query parameters of the operation do not support the channelPartners element. soldTo or parentBulkEntSoldTo should still be used to specify an account in the query request or response.

Derived By

Type searchEntitlementResponseType

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 items in the request were processed.

  • PARTIAL_FAILURE—Some, but not all items in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

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

reason
string
Gives reason for partial failure or failure.
 
entitlement  entitlementDataType  0..*  See entitlementDataType.
Referenced By
Name  Type 
getEntitlementsQuery  Method 
XML Example

The following XML fragment illustrates a successful searchEntitlementResponse message:

<searchEntitlementResponse>
   <statusInfo>
      <status>SUCCESS</status>
   </statusInfo>
   <entitlement>
      <simpleEntitlement>
         <entitlementId>
            <id>Ent_basic_z</id>
         </entitlementId>
         <soldTo>ACME</soldTo>
         <soldToName>ACME Widgets</soldToName>
         <shipToEmail>test@example.com</shipToEmail>
         <shipToAddress>San Jose</shipToAddress>
         <state>DEPLOYED</state>
         <createdUserId>admin</createdUserId>
         <lineItems>
            <activationId>
               <id>Ent_basic_z_1</id>
            </activationId>
            <product>
               <uniqueId>HID-20103</uniqueId>
               <primaryKeys>
                  <name>Product_basic</name>
                  <version>1.0</version>
               </primaryKeys>
            </product>
            <licenseModel>
               <uniqueId>HID-21005</uniqueId>
               <primaryKeys>
                  <name>FC Ent Policies</name>
               </primaryKeys>
            </licenseModel>
            <licenseModelAttributes>
               <attribute>
                  <attributeName>NOTICE</attributeName>
                  <stringValue>notice</stringValue>
               </attribute>
               <attribute>
                  <attributeName>SERIAL_NUMBER</attributeName>
                  <stringValue>serial</stringValue>
               </attribute>
            </licenseModelAttributes>
            <orderId>OR125</orderId>
            <orderLineNumber>1</orderLineNumber>
            <numberOfCopies>10</numberOfCopies>
            <isPermanent>false</isPermanent>
            <expirationDate>2008-11-30</expirationDate>
            <versionDateAttributes>
               <versionOption>DEFINE_NOW</versionOption>
            </versionDateAttributes>
            <numberOfRemainingCopies>10</numberOfRemainingCopies>
            <isTrustedType>false</isTrustedType>
            <state>DEPLOYED</state>
            <licenseTechnology>
               <uniqueId>HID-100</uniqueId>
               <primaryKeys>
                  <name>FLEXnet Licensing</name>
               </primaryKeys>
            </licenseTechnology>
         </lineItems>
      </simpleEntitlement>
   </entitlement>
</searchEntitlementResponse>