Share via

2.2.4.42 t:ItemResponseShapeType Complex Type

  • Article

The ItemResponseShapeType complex type specifies a set of properties to return in a GetItem operation, as specified in [MS-OXWSCORE] section 3.1.4.4, FindItem operation, as specified in [MS-OXWSSRCH] section 3.1.4.2, or SyncFolderItems operation, as specified in [MS-OXWSSYNC] section 3.1.4.2, response.

 <xs:complexType name="ItemResponseShapeType">
     <xs:sequence>
         <xs:element name="BaseShape" type="t:DefaultShapeNamesType"/>
         <xs:element name="IncludeMimeContent" type="xs:boolean" minOccurs="0"/>
         <xs:element name="BodyType" type="t:BodyTypeResponseType" minOccurs="0"/>
         <xs:element name="UniqueBodyType" type="t:BodyTypeResponseType" minOccurs="0"/>
         <xs:element name="NormalizedBodyType" type="t:BodyTypeResponseType" minOccurs="0"/>
         <xs:element name="FilterHtmlContent" type="xs:boolean" minOccurs="0"/>
         <xs:element name="ConvertHtmlCodePageToUTF8" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element name="InlineImageUrlTemplate" type="xs:string" minOccurs="0" maxOccurs="1"/>
         <xs:element name="BlockExternalImages" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element name="AddBlankTargetToLinks" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element name="MaximumBodySize" type="xs:int" minOccurs="0" maxOccurs="1"/>        <xs:element name="AdditionalProperties" type="t:NonEmptyArrayOfPathsToElementType" minOccurs="0"/>
     </xs:sequence>
 </xs:complexType>
 

The following table lists the child elements of the ItemResponseShapeType complex type.

Element name

Type

Description

BaseShape

t:DefaultShapeNamesType (section 2.2.5.7)

Specifies the requested base properties to return in a response. This element MUST be present.

IncludeMimeContent

xs:boolean ([XMLSCHEMA2])

Specifies whether the MIME content of an item is returned in a response. This element is invalid for SyncFolderItems operation.<53>

BodyType

t:BodyTypeResponseType (section 2.2.5.1)

Specifies the requested body text format for the Body property that is returned in a response. If this element is not present, the server MUST use the default value of "Best".

UniqueBodyType

t:BodyTypeResponseType

Specifies whether the unique body is returned in text or HTML format.<54>

NormalizedBodyType

t:BodyTypeResponseType

Specifies whether the normalized body is returned in text or HTML format.<55>

FilterHtmlContent

xs:boolean

Specifies whether HTML content filtering is enabled. If this value is set to true, potentially unsafe HTML content like script blocks MUST be removed from message bodies that are returned in a response.<56>

ConvertHtmlCodePageToUTF8

xs:boolean

Specifies whether the item HTML body is converted to UTF8. The value of this element MUST be set to true or the element MUST NOT be specified to indicate to the server to convert the HTML code page to UTF8. <57>

InlineImageUrlTemplate

xs:string ([XMLSCHEMA2])

Specifies the name of the template for the inline image URL.<58>

BlockExternalImages

xs:boolean

Specifies whether external images are blocked.<59>

AddBlankTargetToLinks

xs:boolean

Specifies whether the target attribute is set to a value of blank.<60>

MaximumBodySize

xs:int ([XMLSCHEMA2])

Specifies the maximum size of the body to return.<61>

AdditionalProperties

t:NonEmptyArrayOfPathsToElementType (section 2.2.4.48)

Specifies a set of requested additional properties to return in a response.