|
FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE |
FlexNet Operations Web Services Guide |
FlexNet Operations supports the integration of software license delivery into the business operations of software producers. Much of its functionality is exposed as Web services to facilitate its integration with software producer back office systems.
FlexNet Operations Web services are accessed using a document-style SOAP mechanism from client applications that you write. SOAP is an XML-based protocol that supports information exchange using HTTP and has implementations in many programming languages. Because each Web service is a document-style SOAP service, its parameters are sent in a specific XML format. This format is defined in a service-specific XML Schema document and a WSDL file. A language-specific client implementation (for example, C, C++, Java, Visual Studio .NET, Perl) of each interface can be generated from its WSDL file.
A WSDL file defines the interface to each web service. The custom data types and XML Schema elements specific to each interface are defined in one or more companion XML Schema documents.
IMPORTANT: All READ services have a maximum batch size of 2000 records. All WRITE services have a maximum batch size of 25 records.
Note the following:
The maximum supported batch size of 2000 records for SOAP READ services represents a system limit and is not a recommended usage for all scenarios.
In hosted, multi-tenant deployments of FlexNet Operations, it is a best practice to retrieve data in smaller batches and use pagination to improve performance and reduce system load.
SOAP requests that require complete details for a large number of records may take longer to process due to shared infrastructure and varying query execution plans.
For improved performance and scalability, customers are advised to:
Use smaller batch sizes (for example, 200 records), or
Select a batch size appropriate to their business requirements, and
Retrieve the complete data set using pagination.
Pagination Example
Request 1: batchSize=200, pageNumber=1
Request 2: batchSize=200, pageNumber=2
Request 3: batchSize=200, pageNumber=3
FlexNet Operations Web Services use a separate versioning system from the overall FlexNet Operations product. To provide producers with greater flexibility when managing their own Web Service client code, new Web Service versions are created as new features are added to existing services. For more information about web service versioning, see the FlexNet Operations Web Service Integration Guide.
The following table shows the current version for each service:
| Web Service | Current Version |
|---|---|
| Product Packaging Service |
v3 |
| Entitlement Order Service |
v9 |
| License Service |
v2 |
| FlexNet Authentication Service |
v1 |
| User Account Hierarchy Service |
v6 |
| Manage Device Service |
v9 |
| Download Packaging Service |
v4 |
| Usage Service |
v1 |
| ESD Service |
base |
| Name | Description |
|---|---|
| ProductPackagingService | Web service to create, update, delete, count and query various product packaging definitions. |
| EntitlementOrderService | Web service to create, update, delete, count and query entitlements. |
| LicenseService | Web service to create, rehost, repair, return, query of license activations. |
| FlexnetAuthenticationService | Web service to manage Flexnet authentication. |
| UserAcctHierarchyService | Web service to create, update and query account hierarchies as well as to create, update or delete users and user roles in an account. |
| ManageDeviceService | Web service to manage devices. |
| DownloadPackagingService | The Download Packaging Web Service is an add-on to the FlexNet Operations entitlement management system. |
| UsageService | Web service to retrieve real-time, reconciled usage data for an account. |
| ESDService | Electronic Software Delivery Service (ESD Service) provides interfaces for accessing information related to the Software Delivery Module. |
| Appendix-A | Web Service Data Types with Choices |
| Appendix-B | License Model Attributes |
| Appendix-C | ClientSecurityCredentials Class Source |
| Appendix-D | Error Codes |
| Appendix-E |
Supported Hostid Types |