3.1.4.7 SetSubscriptionPropertySet

  • Article

The SetSubscriptionPropertySet operation creates a new property set and a new mapping between it and the site subscription identifier specified in the input message.

The following is the WSDL port type specification of the SetSubscriptionPropertySet WSDL operation.

 <wsdl:operation name="SetSubscriptionPropertySet" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://tempuri.org/ISubscriptionSettingsServiceApplication/SetSubscriptionPropertySet" message="tns:ISubscriptionSettingsServiceApplication_SetSubscriptionPropertySet_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://tempuri.org/ISubscriptionSettingsServiceApplication/SetSubscriptionPropertySetResponse" message="tns:ISubscriptionSettingsServiceApplication_SetSubscriptionPropertySet_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://tempuri.org/ISubscriptionSettingsServiceApplication/SetSubscriptionPropertySetSPSubscriptionSettingsActionFaultFault" name="SPSubscriptionSettingsActionFaultFault" message="tns:ISubscriptionSettingsServiceApplication_SetSubscriptionPropertySet_SPSubscriptionSettingsActionFaultFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

The protocol client sends an IsubscriptionSettingsServiceApplication_SetSubscriptionPropertySet_InputMessage request WSDL message and the protocol server MUST respond with an IsubscriptionSettingsServiceApplication_SetSubscriptionPropertySet_OutputMessage response WSDL message as follows:

  1. If the property set in the input message is NULL, the protocol server MUST return a SPSubscriptionSettingsActionFault SOAP fault with the SPSubscriptionSettingsActionFaultType element set to the value "ArgumentNullException" as specified in section 2.2.5.3.

  2. If the site subscription identifier in the input message is empty, the protocol server MUST return a SPSubscriptionSettingsActionFault SOAP fault with the SPSubscriptionSettingsActionFaultType element set to the value "ArgumentOutOfRangeException".

  3. The protocol server MUST generate a new GUID for the property set and store the property set in the list of property sets.

  4. If the mapping does not exist between the property set type identifier and the site subscription identifier, the protocol server MUST create a new mapping, and then associate it with the input property set.

  5. The protocol server MUST return a SPSubscriptionSettingsActionFault SOAP fault with the SPSubscriptionSettingsActionFaultType element set to the value "SPDatabaseException" for each of the following cases. The state of the protocol server MUST NOT change for any of these cases.

    1. The property set was not created.

    2. A mapping between the property set type identifier and the site subscription identifier already exists.

    3. The mapping was not created.

  6. If the protocol server creates the specified property set, and also creates the mapping between it and the site subscription identifier, then the protocol server MUST return a SPSubscriptionSettingsPropertySetInfo element that contains the property set identifier and version stamp elements as specified in section 2.2.4.5.