Partager via

  • Article

Web Service Response Shapes in Exchange 2010

Last modified: September 14, 2010

Applies to: Exchange Server 2007 | Exchange Server 2010

The Exchange data store provides a flexible storage solution for a number of items. This flexibility enables you to store different items, such as contacts and calendar entries, in the same folder; however, it can make it difficult to manage the data that is returned from a call to an Exchange Web Service (EWS) operation.

To make it easier to manage the data that is returned by an EWS operation, EWS uses response shapes, which are predefined collections of properties that provide the most common properties for a store item. The set of properties that is returned is determined by the item type and the folder that contains the item. This means that the GetItem Operation will return one set of properties when it returns a Calendar item, and another set of properties when it returns a Contact item. The GetFolder Operation does the same, returning one set of properties for a Calendar folder, and another set of properties for a Contacts folder.

There are three predefined response shapes, as described in the following table.

Response shape

Description

ID only

Returns only the identifier of the item or folder.

Default

Returns a predefined set of properties that are the default for the item or folder.

All properties

Returns all properties that are used by the Exchange server for the item or folder.

Default Response Shape

The default response shape includes default properties for folders and for items.

Default Folder Properties

The following table lists the default properties that are returned for each folder by the FindFolder Operation and the GetFolder Operation.

Property

Inbox

Calendar

Contacts

Deleted items

Drafts

Notes

Other folders

Outbox

Display name

X

X

X

X

X

X

X

X

Folder ID

X

X

X

X

X

X

X

X

Subfolder count

X

X

X

X

X

X

X

X

Total count

X

X

X

X

X

X

X

Unread count

X

X

X

X

X

Default Item Properties

The following table lists the default properties that are returned for each item type by the FindItem Operation and the GetItem Operation.

Property

Calendar item

Contact item

Message item

Task item

Body

X(1)

CalendarItemType

x

CompanyName

x

CompleteName

x

DateTimeCreated

x

DateTimeSent

x

DueDate

x(2)

EmailAddresses

x

End

x

FileAs

x

From

x

HasAttachments

x

x

x

x

ImAddresses

x

IsAssociated

x

x

IsDeliveryReceiptRequested

x

ItemId

x

x

x

x

JobTitle

x

LegacyFreeBusyStatus

x

Location

x

Organizer

x

PercentComplete

x

PhoneNumbers

x

PhysicalAddresses

x

ResponseObjects

x(1)

x(1)

Sensitity

x

Size

x

StartDate

x(2)

Status

x

Subject

x

x

x

Notes:

  1. Included in the response from the GetItem Operation. Not included in the response from the FindItem Operation.

  2. Only included in the response if the field contains data. Not included in the response if the field is blank.

All Properties Response Shape

The following table lists the properties that are returned by the FindItem Operation and the GetItem Operation for the all properties response shape.

Property

Calendar item

Contact item

Message item

Task item

ActualWork

x

AppointmentSequenceNumber

x

AppointmentState

x

BillingInformation

x

Body

x(1)

x(1)

x(1)

x(1)

BusinessHomePage

x

CalendarItemType

x

ChangeCount

x

CompleteName

x

ConversationId

x

x

x

x

ConversationIndex

x

ConversationTopic

x

Culture

x

x

x

x

DateTimeCreated

x

x

x

x

DateTimeReceived

x

x

x

x

DateTimeSent

x

x

x

x

DateTimeStamp

x

Department

x

DisplayCc

x

x

x

x

DisplayName

x

DisplayTo

x

x

x

x

Duration

x

EffectiveRights

x

x

x

x

EmailAddresses

x

End

x

FileAs

x

FileAsMapping

x

From

x

GivenName

x

HasAttachments

x

x

x

x

ImAddresses

x

Importance

x

x

x

x

InternetMessageId

x

IsAllDayEvent

x

IsAssociated

x

x

x

x

IsCancelled

x

IsComplete

x

IsDeliveryReceiptRequested

x

IsDraft

x

x

x

x

IsFromMe

x

x

x

x

IsMeeting

x

IsRead

x

IsReadReceiptRequested

x

IsRecurring

x

x

IsResend

x

x

x

x

IsResponseRequested

x

IsSubmitted

x

x

x

x

IsUnmodified

x

x

x

x

ItemClass

x

x

x

x

ItemId

x

x

x

x

JobTitle

x

LastModifiedName

x

x

x

x

LastModifiedTime

x

x

x

x

LegacyFreeBusyStatus

x

Location

x

Manager

x

MeetingRequestWasSent

x

MiddleName

x

Mileage

x

MyResponseType

x

OfficeLocation

x

Organizer

x

Owner

x

ParentFolderId

x

x

x

x

PercentComplete

x

PhoneNumbers

x

PhysicalAddresses

x

PostalAddressIndex

x

ReceivedBy

x

ReceivedRepresenting

x

ReminderDueBy

x

x

ReminderIsSet

x

x

ReminderMinutesBeforeStart

x

x

ResponseObjects

x(1)

x(1)

Sender

x

Sensitivity

x

x

x

Size

x

x

x

x

Start

x

x

Status

x

Subject

x

x

x

x

Surname

x

TimeZone

x

TotalWork

x

UID

x

WebClientEditFormQueryString

x

x

x

WebClientReadFormQueryString

x

x

x

x

Notes:

  1. Included in the response from the GetItem Operation. Not included in the response from the FindItem Operation.