Export (0) Print
Expand All

3.1.4.1 GetServiceConfiguration Operation

The GetServiceConfiguration WSDL operation gets the service configuration for a mailbox.

<wsdl:operation name="GetServiceConfiguration">
    <wsdl:input message="tns:GetServiceConfigurationSoapIn" />
    <wsdl:output message="tns:GetServiceConfigurationSoapOut" />
</wsdl:operation>

The following is the WSDL binding specification for the GetServiceConfigurationWSDL operation.

<wsdl:operation name="GetServiceConfiguration">
  <soap:operation
      soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/
      GetServiceConfiguration"/>
  <wsdl:input>
    <soap:body parts="request" use="literal"/>
    <soap:header message="tns:GetServiceConfigurationSoapIn" part="Impersonation"
        use="literal"/>
    <soap:header message="tns:GetServiceConfigurationSoapIn" part="RequestVersion"
        use="literal"/>
    <soap:header message="tns:GetServiceConfigurationSoapIn" part="MailboxCulture"
        use="literal"/>
  </wsdl:input>
  <wsdl:output>
    <soap:body parts="GetServiceConfigurationResult" use="literal"/>
    <soap:header message="tns:GetServiceConfigurationSoapOut" part="ServerVersion"
        use="literal"/>
  </wsdl:output>
</wsdl:operation>

A successful GetServiceConfiguration WSDL operation request returns a GetServiceConfigurationResponse element, as specified in section 3.1.4.1.2.2, with the ResponseClass attribute, as defined in [MS-OXWSCDATA] section 2.2.4.57, set to "Success". The ResponseCode element of the GetServiceConfigurationResponse element, as specified in [MS-OXWSCDATA] section 2.2.4.57, is set to "NoError".

If the GetServiceConfiguration WSDL operation is not successful, the operation returns a GetServiceConfigurationResponse element with the ResponseClass attribute set to "Error". The ResponseCode element of the GetServiceConfigurationResponse element is set to one of the common errors defined in [MS-OXWSCDATA] section 2.2.5.23.

The GetServiceConfiguration WSDL operation MUST use the SOAP fault specified in this section if the request XML is malformed according the schema specified in sections 6 and 7. The following XML specifies the structure of the SOAP fault that is returned when a request contains malformed XML. This message is not specified in the schema.

<s:Body>
  <s:Fault>
    <faultcode
        xmlns:a="http://schemas.microsoft.com/exchange/services/2006/types">
        a:ErrorSchemaValidation
    </faultcode>
    <faultstring xml:lang="en-US">The request failed schema validation: The element
        'RequestedConfiguration' in namespace
        'http://schemas.microsoft.com/exchange/services/2006/messages'
        has incomplete content. List of possible elements expected:
        'ConfigurationName' in namespace
        'http://schemas.microsoft.com/exchange/services/2006/messages'.
    </faultstring>
    <detail>
      <e:ResponseCode
          xmlns:e="http://schemas.microsoft.com/exchange/services/2006/errors">
          ErrorSchemaValidation
      </e:ResponseCode>
      <e:Message
          xmlns:e="http://schemas.microsoft.com/exchange/services/2006/errors">
          The request failed schema validation.</e:Message>
      <e:MessageXml
          xmlns:e="http://schemas.microsoft.com/exchange/services/2006/errors">
        <t:LineNumber
            xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
            16
        </t:LineNumber>
        <t:LinePosition
            xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
            9
        </t:LinePosition>
        <t:Violation
            xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
            The element 'RequestedConfiguration' in namespace
            'http://schemas.microsoft.com/exchange/services/2006/messages'
            has incomplete content. List of possible elements expected:
           'ConfigurationName' in namespace
           'http://schemas.microsoft.com/exchange/services/2006/messages'.
        </t:Violation>
      </e:MessageXml>
    </detail>
  </s:Fault>
</s:Body>

The faultcode element MUST have a text value of "a:ErrorSchemaValidation".

The faultstring element contains a human-readable explanation of the fault.

The detail element contains application-specific error information. This element is specified by the following child elements:

  • ResponseCode: This element MUST have a text value of "ErrorSchemaValidation".

  • Message: This element MUST have a text value of "The request failed schema validation.".

  • MessageXML: This element contains additional error response information. This information includes the line number of the error, specified by the LineNumber element; the line position of the error, specified by the LinePosition element; and a human-readable explanation of the fault, specified by the Violation element.

Show:
© 2015 Microsoft