3.1.4.4 GetSubscriptionPropertySet

  • Article

The GetSubscriptionPropertySet operation returns the property set with the specified type identifier and maps to the site subscription identifier specified in the input message.

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

 <wsdl:operation name="GetSubscriptionPropertySet" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://tempuri.org/ISubscriptionSettingsServiceApplication/GetSubscriptionPropertySet" message="tns:ISubscriptionSettingsServiceApplication_GetSubscriptionPropertySet_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://tempuri.org/ISubscriptionSettingsServiceApplication/GetSubscriptionPropertySetResponse" message="tns:ISubscriptionSettingsServiceApplication_GetSubscriptionPropertySet_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://tempuri.org/ISubscriptionSettingsServiceApplication/GetSubscriptionPropertySetSPSubscriptionSettingsActionFaultFault" name="SPSubscriptionSettingsActionFaultFault" message="tns:ISubscriptionSettingsServiceApplication_GetSubscriptionPropertySet_SPSubscriptionSettingsActionFaultFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </wsdl:operation>

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

  1. If the property set type identifier or the site subscription identifier specified in the input message are null, the protocol server MUST return a SPSubscriptionSettingsActionFault SOAP fault with the SPSubscriptionSettingsActionFaultType set to the value "ArgumentOutOfRangeException" as specified in section2.2.5.3.

  2. If a property set with the type identifier specified in the input message exists, and the property set has a mapping to the specified site subscription identifier, the protocol server sets the m_Exists element set to TRUE and MUST return a response message of type SPSubscriptionSettingsPropertySetResult as specified in section 2.2.4.6.  The response message contains information about the property set.

  3. If a mapping for the specified type identifier and site subscription identifier specified in the input message does not exist, or if the property set associated with the mapping for the site subscription identifier and type identifier does not exist, the protocol server MUST return a response element of type SPSubscriptionSettingsPropertySetResult with the m_Exists element set to FALSE.