updateSubservice()

void updateSubservice(Subservice sNew)

This method alters information of a subservice.

Parameters

sNew
Format: Subservice XML
Purpose: Specifies a Subservice XML document that contains information about the subservice to be updated. The <SSID> and <SubscriptionUSN> elements must be set correctly for this purpose.
Note: It is not possible to change the SSID or SubscriptionUSN properties for a subservice once created. To re-assign a subservice to another subscription, you must delete the subservice via removeSubservice() and create another one via addSubservice().

Example: A Subservice XML document

This example shows a Subservice XML document.

<Subservice xmlns="http://xml.inomial.com/smile/2.xsd">
  <SSID>2344</SSID>
  <SubscriptionUSN>9796932323</SubscriptionUSN>
  <Active>true</Active>
  <SubserviceUsername>joe@example.com</SubserviceUsername>
  <Object>
    <String name="type">emailAccount</String>
    <Integer name="quotaGB">10</Integer>
    <Boolean name="spamFilteringEnabled">true</Boolean>
  </Object>
</Subservice>

Results

No results are returned by this method.

There are no messages defined by this method.

Faults

NoSuchItemException
This fault is returned when:
  • no subservice with the given SSID exists in the database
  • no subscription with the given SubscriptionUSN exists in the database
  • the subservice given by SSID does not belong to the subscription given by SubscriptionUSN
InvalidRequestException
This fault is returned when an attempt is made to rename a subservice to a username that is either:
  • not correctly formed, as determined by the configuration of the service associated with the subscription
  • already in use by another subservice or subscription, as determined by the configuration of the service associated with the subscription

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.UpdateSubservice filename
filename
Purpose: Specifies the filename of the Subservice XML document.
Note: For more information about the Java client and the options it accepts, see Java client syntax.