General Deserialization Rules

This section describes process of deserialization of the input XML.
Depending of the API action (DELETE/ADD/UPDATE/ADDORUPDATE), the input XML is treated differently. If the action is ADD, all nodes that are described as required in below section, are really in need to be present in input XML. When action is UPDATE, the required nodes can be omitted from input XML. However, if these nodes are present in input XML, they must not be empty. If the action is ADDORUPDATE and the existing user is being updated, the required nodes can be omitted. In that case, the existing user will preserve previous value for that node. However, if the action is ADDORUPDATE and the new user is being created, the API call will fail if a required node is not supplied.
Every node from input XML is being copied to respective CPQ user field. If the node is not present in input XML, it will not be copied, and the respective user's field will remain as it was before API call. So, omit the node if you don't want to affect its previous content. If the node is present, and if it is empty (has no content), it will erase respective user's field. If the node is required, and is supplied empty, the API call will fail, and the caller will get the XML response with error message. Required fields cannot be erased from existing users, and no new users can be created without setting required fields. If the node is required, and is not supplied in input XML, and the action is UPDATE, the user will preserve his original respective field. However, if the action is ADD, the API call will fail, returning the XML to the caller, with error message. For ADD, the required nodes must be present. ADDORUPDATE allows the nodes to be absent, but the API call will fail, if ADDORUPDATE action is creating new user and not updating existing one. In that case, the caller will receive result XML with error message.
The nodes that should contain boolean values accept only '1' , '0', 'true' and 'false' values.

You are here: SAP Sales Cloud CPQ Online HelpSAP CPQ APIUser Administration Web MethodGeneral Deserialization Rules