4.3 GetUserConfiguration Operation

  • Article

The following example of a GetUserConfiguration operation request, as described in section 3.1.4.3, shows how to form a request to get a user configuration object on the Inbox folder.

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <RequestServerVersion Version="Exchange2013" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />

  </soap:Header>

  <soap:Body>

    <GetUserConfiguration xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">

      <UserConfigurationName Name="PersonalDetails">

        <DistinguishedFolderId Id="inbox" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />

      </UserConfigurationName>

      <UserConfigurationProperties>All</UserConfigurationProperties>

    </GetUserConfiguration>

  </soap:Body>

</soap:Envelope>

The following example shows a successful response to the GetUserConfiguration operation request.

In this example, Id and ChangeKey attributes of the ItemId element, encoded with base64 encoding, have been shortened to preserve the readability.

<?xml version="1.0" encoding="utf-8"?>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

  <s:Header>

    <h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="1054" MinorBuildNumber="12" Version="Exchange2013" xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

  </s:Header>

  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <m:GetUserConfigurationResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">

      <m:ResponseMessages>

        <m:GetUserConfigurationResponseMessage ResponseClass="Success">

          <m:ResponseCode>NoError</m:ResponseCode>

          <m:UserConfiguration>

            <t:UserConfigurationName Name="PersonalDetails">

              <t:DistinguishedFolderId Id="inbox"/>

            </t:UserConfigurationName>

            <t:ItemId Id="AAMGUxYmU1Zj=" ChangeKey="CQAAABYAUKH"/>

            <t:Dictionary>

              <t:DictionaryEntry>

                <t:DictionaryKey>

                  <t:Type>String</t:Type>

                  <t:Value>Birthday</t:Value>

                </t:DictionaryKey>

                <t:DictionaryValue>

                  <t:Type>DateTime</t:Type>

                  <t:Value>2000-01-01T00:00:00Z</t:Value>

                </t:DictionaryValue>

              </t:DictionaryEntry>

            </t:Dictionary>

          </m:UserConfiguration>

        </m:GetUserConfigurationResponseMessage>

      </m:ResponseMessages>

    </m:GetUserConfigurationResponse>

  </s:Body>

</s:Envelope>