SOAP Web Services Enhancements in 2022.11
The following features and enhancements were added to the SOAP Web Services module in the 2022.11 release:
Sorting Columns Using getUsersQuery in UserAcctHierarchy Service (v4)
The getUsersQuery method in the UserAcctHierarchy Service now supports the optional sortBy parameter. This enables producers who are building their own Web portal to sort columns.
Only one sortBy parameter can be sent per request.
Here is an example request:
<urn:sortBys>
<urn:sortBy>
<urn:sortKey>EMAIL</urn:sortKey>
<urn:ascending>false</urn:ascending>
</urn:sortBy>
</urn:sortBys>
The following fields can be sorted:
ACCOUNT_NAME
ACCOUNT_ID
CAN_LOGIN
CITY
COUNTRY
DISPLAY_NAME
FIRST_NAME
ISACTIVE
LAST_MODIFIED
LAST_NAME
STATE
Sorting Columns Using getEntitlementLineItemsProperties in EntitlementOrder Service
The getEntitlementLineItemsProperties method in the EntitlementOrder Service now supports the optional sortBy parameter. This enables producers who are building their own Web portal to sort columns.
Only one sortBy parameter can be sent per request.
Here is an example request:
<urn:sortBys>
<urn:sortBy>
<urn:sortKey>LINE_ITEM_LAST_MODIFIED</urn:sortKey>
<urn:ascending>true</urn:ascending>
</urn:sortBy>
</urn:sortBys>
The following fields can be sorted:
ENTITLEMENT_ID
PARENT_BULK_ENTITLEMENT_ID
ACTIVATION_ID
LINE_ITEM_ORDERABLE_NAME
LINE_ITEM_ORDERABLE_VERSION
LINE_ITEM_SKU
LINE_ITEM_START_DATE
LINE_ITEM_EXPIRATION_DATE
LINE_ITEM_ORDER_ID
LINE_ITEM_ORDER_LINE_NUMBER
LINE_ITEM_FULFILLED_AMOUNT
CONTACT
SOLD_TO_NAME
LINE_ITEM_ACTIVATABLE_ITEM_TYPE
SOLD_TO_DISPLAY_NAME
CURRENT_OWNER_ORG_NAME
LINE_ITEM_CREATED_ON
LINE_ITEM_LAST_MODIFIED
Filtering Functionality for searchDevices Operation in Manage Device Web Service (v5)
The searchDevices operation now supports searching and filtering by the parameters addOnExpirationDate and hasLicense.
This enhancement enables producers to filter out devices that have expired or invalid licenses.
Here is an example request:
<urn:addOnExpirationDate>
<urn:value>2015-10-10</urn:value>
<urn:searchType>AFTER</urn:searchType>
</urn:addOnExpirationDate>
<urn:hasLicense>true</urn:hasLicense>
The parameters addOnExpirationDate and hasLicense are both returned in the response, based on the response config parameter.
This change is implemented as part of the Manage Device v5 Web service.