FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Method: createSimpleEntitlement

Description

The createSimpleEntitlement operation creates one or more simple entitlements. To use the Entitlement Order service to create an entitlement:

Note: Using the createSimpleEntitlement operation, it is possible to create a simple entitlement with no line items. Such an entitlement cannot be created through the Administrative Console. One created with web services will not appear in the Administrative Console, though it is saved in the FlexNet Operations database. Therefore, avoid using the createSimpleEntitlement operation to create an entitlement with no line items or with only maintenance items.

You can specify an activation ID using createSimpleEntitlement.

EXAMPLE

<urn:lineItems>
   <urn:activationId>
      <!--Optional:-->
      <!--type: string-->
      <urn:id>quae divum incedo</urn:id>
      <!--Optional:-->
      <!--type: boolean-->
      <urn:autoGenerate>true</urn:autoGenerate>
   </urn:activationId>

In this example, autoGenerate is true or false. If you specify false, it means you need to pass the ID value of the activation ID (which is the custom activation ID).

An activation ID must meet the following requirements:

      ,  "  &  %  ^  (  )  #  @  !  ~  /  <  >  `  }  {  =  |  .

Parameters
Name  Type  Direction  Description 
msgparameters  createSimpleEntitlementRequestType  Input   
Returns

A createSimpleEntitlementResponse element having the structure defined by the following table.

Name  Type  Description 
statusInfo  StatusInfoType 
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.

When the opType is either CREATE_OR_UPDATE or CREATE_OR_IGNORE, the Entitlement response and the Line Item response together result in the final response.

  • Both the Entitlement response and the Line Item response must be a success for the final result to be a success.

  • If one is a success and the other is a failure, the final result is a failure.

  • If one is a partial failure and one is a failure, the final result is a failure.

Note: A line item request cannot succeed in the absence of an entitlement request.

reason
string
Gives reason for partial failure or failure.
 
failedData  failedSimpleEntitlementDataListType  Information about the entitlements that were not added is listed in the failedData element. See failedSimpleEntitlementDataListType.
responseData  createdSimpleEntitlementDataListType  Information about the entitlements that were added is listed in the responseData element. See createdSimpleEntitlementDataListType.