SOAP and REST Web Services Enhancements in 2023.08
The following enhancements were added to the SOAP Web Services module in the 2023.08 release:
| • | ManageDeviceService Web Service Returning License State |
| • | ManageDeviceService Web Service Returning Site Name |
| • | Mass Entitlement Search in EntitlementOrderWebservice Web Service |
| • | Notification Email When Reactivating a User Via SOAP Web Services |
| • | Status Page for Event Notification Service REST API |
ManageDeviceService Web Service Returning License State
The searchDevices operation of the ManageDeviceService web service now returns the licenseState attribute value, if the responseConfig.addOnCounts in the request is set to true.
This change applies to all versions of the ManageDeviceService web service, including the new version 6 (introduced for the enhancement ManageDeviceService Web Service Returning Site Name, see the description below).
ManageDeviceService Web Service Returning Site Name
This release introduces version 6 of the ManageDeviceService web service. In version 6, the getDevice, getDevicesQuery and searchDevices operations can return the siteName attribute value. You can use <responseConfig> to include or exclude the site name in the response.
In addition, in version 6, siteName is available as a search parameter for the getDevicesQuery and searchDevices operations.
Mass Entitlement Search in EntitlementOrderWebservice Web Service
This release introduces version 6 of the EntitlementOrderWebservice web service. Version 6 enables producers to perform a mass entitlement search using the getActivatableItemsQuery operation, which can now return a large number of entitlements and line items that match specified criteria.
To achieve this, the parameter tag <urn:activationIds> ... </urn:activationIds> was added, which accepts multiple activation IDs as input parameters to retrieve all line item details in a single request.
Note:In v6 of the EntitlementOrderWebservice web service, the parameter tag <urn:activationId> ... </urn:activationId> is now wrapped inside the new parameter tag <urn:activationIds> ... </urn:activationIds>. To search for a single activation ID, pass the activation ID in <urn:activationId> ... </urn:activationId>.
Notification Email When Reactivating a User Via SOAP Web Services
When a user is reactivated—that is, the user’s state is changed from Inactive to Active—using the Producer Portal UI, a user activation email is automatically sent to the user, informing them about the change of state.
To maintain parity of behavior between the Producer Portal UI and SOAP web services, a new configuration option Send email when user is reactivated via web services has been introduced (under System > Configure > FlexNet Operations > General Options). This configuration option lets producers choose whether an email should be automatically triggered when a user is reactivated using the SOAP web services updateUser or createUser operation.
By default, the configuration option is disabled; that is, no email is sent when a user is reactivated through web services.
Producers who enable the configuration option should ensure that the User Enabled email template contains appropriate content, that it is active and that its Send Indicator is set to true.
Status Page for Event Notification Service REST API
Version:The Event Notification Service REST API is applicable only to customers on Amazon Web Services (AWS) instances of FlexNet Operations.
The Event Notification Service REST API includes a new /health/status endpoint (method: GET), which can be used to monitor the status of the Event Notification Service.
The response returns the status; possible responses are as follows:
| • | 200: OK. Includes the status as UP or DOWN. |
| • | 503: Service Temporarily Unavailable. Returned if the service itself is offline or unreachable. |