FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Method: createWebRegKey

Description

The createWebRegKey operation adds one or more web register keys to one or more bulk entitlements, either asynchronously or synchronously. By default, web register key creation is asynchronous. To use the Entitlement Order service to load web register keys:

There must be bulk entitlements in the FlexNet Operations database.

If web register keys are going to be imported asynchronously, the Importing Bulk Entitlement Web Register Keys alert must be configured. See the FlexNet Operations Online Help for instructions. Before checking whether the web register keys were really added, wait until after the import has triggered. With synchronous processing, the Web services client will be blocked until the request is completely processed. Therefore, use synchronous processing to load only for small numbers of web register keys at a time. The Importing Bulk Entitlement Web Register Keys alert does not have to be configured to load web register keys synchronously.

Parameters
Name  Type  Direction  Description 
msgparameters  addWebRegKeyRequestType  Input   
Returns

A addWebRegKeyResponse 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—If the request was synchronous, all of the web register keys in the request were processed successfully. If the request was asynchronous, SUCCESS means that the import request of web register keys was scheduled; this does not necessarily mean that the request was processed successfully.

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

  • FAILURE—If the request was synchronous, none of the web register keys in the request were processed successfully. If the request was asynchronous, FAILURE means that the import request of web register keys was not scheduled.

reason
string
Gives reason for partial failure or failure.
 
responseData  webRegKeyDataListType  Information about the web register keys that were added is listed in the responseData element. See webRegKeyDataListType. Not populated for asynchronous requests or for requests in which the web register keys are not autogenerated.
failedData  failedAddWebRegKeyDataListType  Information about the web register keys that were not added is listed in the failedData element. See failedAddWebRegKeyDataListType. Not populated for asynchronous requests or for requests in which the web register keys are autogenerated.