Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

3.1.4.4 GetItem

The GetItem operation enables the user to get email messages and to access information about email messages.

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

<wsdl:operation name="GetItem">
  <wsdl:input message="tns:GetItemSoapIn" />
  <wsdl:output message="tns:GetItemSoapOut" />
</wsdl:operation>

The following is the WSDL binding specification of the GetItem operation.

<wsdl:operation name="GetItem">
  <soap:operation soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/GetItem" />
  <wsdl:input>
    <soap:header message="tns:GetItemSoapIn" part="Impersonation" use="literal"/>
    <soap:header message="tns:GetItemSoapIn" part="MailboxCulture" use="literal"/>
        <soap:header message="tns:GetItemSoapIn" part="RequestVersion" use="literal"/>
    <soap:header message="tns:GetItemSoapIn" part="TimeZoneContext" use="literal"/>
    <soap:body parts="request" use="literal" />
  </wsdl:input>
  <wsdl:output>
    <soap:body parts="GetItemResult" use="literal" />
    <soap:header message="tns:GetItemSoapOut" part="ServerVersion" use="literal"/>
  </wsdl:output>
</wsdl:operation>

The GetItem operation request MUST include the elements listed in the following table.

Element name

Description

ItemShape

Specifies a set of properties to be returned. The child elements for this element are listed in the following table.

ItemIds

Contains the unique identities of items. This element includes the Id attribute, which identifies a specific item in the store, and the ChangeKey attribute, which identifies a specific version of an item.

The child elements of the ItemShape element are listed in the following table.

Element name

Description

BaseShape

Identifies the basic configuration of properties to be returned in an item response. Set this element to IdOnly to return only the item ID, or set it to AllProperties to return all of the properties used by the server to construct a message. This element MUST be present.

IncludeMimeContent

Indicates whether MIME content is included in a returned message or attachment.

BodyType

Indicates whether a message body is returned as HTML.

FilterHtmlContent

Indicates whether to filter unsafe HTML content from a message or attachment.

AdditionalProperties

Identifies additional item properties to be returned in a response.

The protocol client sends a GetItemSoapIn request WSDL message, and the protocol server responds with a GetItemSoapOut response WSDL message.

If the GetItemWSDL operation request is successful, the server returns a GetItemResponse element, as specified in [MS-OXWSCORE] section 3.1.4.4.2.2, with the ResponseClass attribute, as specified in [MS-OXWSCDATA] section 2.2.4.57, of the GetItemResponseMessage element, as specified in [MS-OXWSCDATA] section 2.2.4.10, set to "Success". The ResponseCode element, as specified in [MS-OXWSCDATA] section 2.2.4.57, of the GetItemResponseMessage element is set to "NoError".

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

For more information, see GetItem as described in [MS-OXWSCORE] section 3.1.4.2.

Show:
© 2015 Microsoft