SOAP and REST Web Services Enhancements in 2025.02

The following enhancements were added to the SOAP and REST Web Services module in the 2025.02 release.

•

Returning Fulfillment and License Information for Non-Embedded Technologies Using Web Services

•

New Operation for Getting Host Count in License Service SOAP Web Service

Returning Fulfillment and License Information for Non-Embedded Technologies Using Web Services

(Case 02370066, SWM-22714)

In the Producer Portal, producers can list fulfillment or license information for non-embedded licensing technology (such as FlexNet Publisher) for specific hostids on the Support Licenses and Maintenance page (under Licenses > Hosts). The following screenshot shows the Support Licenses and Maintenance page along with the search options:

To provide the same functionality using web services, the 2025.02 release now introduces version 2 of the LicenseService SOAP web service. This enhancement enables producers to do the following:

•

Collect all hostids to provide a list of current hostids for new activations

•

Collect all active fulfillments for a dedicated server in preparation to create "emergency" licenses for that server

•

Collect fulfillment and license information in preparation to rehost a server

Implementation of getHostQuery

Version 2 of the LicenseService SOAP web service includes the new operation getHostQuery. The following XML fragment illustrates a getHostQuery message:

<operation name="getHostQuery">

<input message="tns:getHostQueryRequest"/>

<output message="tns:getHostQueryResponse"/>

</operation>

The operation getHostQuery extracts the same information as that available on the Support Licenses and Maintenance page: Host ID, Sold To, Account, License Technology, and Host Type. In addition, producers can filter for hosts that have active or inactive fulfillments.

Tip:For pagination, producers can use the getHostCount operation to determine the number of hosts and specify that number in the batchSize parameter (see New Operation for Getting Host Count in License Service SOAP Web Service ).

The following snippet shows sample XML code:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:v2.webservices.operations.flexnet.com">

<soapenv:Header/>

<soapenv:Body>

<urn:getHostQueryRequest>

<!--Optional:-->

<urn:queryParams>

<!--Optional:-->

<urn:hostId>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:hostId>

<!--Optional:-->

<urn:soldTo>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:soldTo>

<!--Optional:-->

<urn:licenseTechnology>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:licenseTechnology>

<!--Optional:-->

<urn:hostType>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:hostType>

<!--Optional:-->

<urn:account>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:account>

<!--Optional:-->

<urn:fulfillmentState>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:fulfillmentState>

</urn:queryParams>

<urn:pageNumber>?</urn:pageNumber>

<urn:batchSize>?</urn:batchSize>

</urn:getHostQueryRequest>

</soapenv:Body>

</soapenv:Envelope>

For detailed information about the changes made to the LicenseFulfillmentService.wsdl and the .xsd files that it references, see the Change Log for 2025.02.

New Operation for Getting Host Count in License Service SOAP Web Service

(Related to Case 02370066, SWM-25245)

Along with the getHostQuery operation (see Returning Fulfillment and License Information for Non-Embedded Technologies Using Web Services), version 2 of the LicenseService SOAP web service also introduces the getHostCount operation. getHostCount returns the number of hosts that match specified criteria.

This operation is equivalent to displaying the number of hosts that fit certain criteria by filtering hosts using the Search for option in the Producer Portal in the Support Licenses and Maintenance page:

Implementation of getHostCount

The following XML fragment illustrates a getHostCount message:

<operation name="getHostCount">

<input message="tns:getHostCountRequest"/>

<output message="tns:getHostCountResponse"/>

</operation>

The operation getHostCount returns the number of hosts that fit specified criteria. The following search criteria are available: Host ID, Sold To, Account, License Technology, and Host Type.

Tip:The returned number can be used as the batch size input for getHostQuery (see Returning Fulfillment and License Information for Non-Embedded Technologies Using Web Services).

The following snippet shows sample XML code:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:v2.webservices.operations.flexnet.com">

<soapenv:Header/>

<soapenv:Body>

<urn:getHostCountRequest>

<!--Optional:-->

<urn:queryParams>

<!--Optional:-->

<urn:hostId>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:hostId>

<!--Optional:-->

<urn:soldTo>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:soldTo>

<!--Optional:-->

<urn:licenseTechnology>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:licenseTechnology>

<!--Optional:-->

<urn:hostType>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:hostType>

<!--Optional:-->

<urn:account>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:account>

<!--Optional:-->

<urn:fulfillmentState>

<urn:value>?</urn:value>

<urn:searchType>?</urn:searchType>

</urn:fulfillmentState>

</urn:queryParams>

</urn:getHostCountRequest>

</soapenv:Body>

</soapenv:Envelope>

For detailed information about the changes made to the LicenseFulfillmentService.wsdl and the .xsd files that it references, see the Change Log for 2025.02.