ResponseMessage

The ResponseMessage element provides descriptive information about the response status for a single entity within a request.

<ResponseMessage ResponseClass="">
   <MessageText/>
   <ResponseCode/>
   <DescriptiveLinkKey/>
   <MessageXml/>
</ResponseMessage>

ResponseMessageType

Attributes and elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description
ResponseClass
Represents the status of the response.

The following values are valid for this attribute:

- Success
- Warning
- Error

ResponseClass attribute values

Value Description
Success
Describes a request that is fulfilled.
Warning
Describes a request that was not processed. A warning may be returned if an error occurred while an item in the request was processing and subsequent items could not be processed.

The following are some possible causes for warnings:

- The Exchange store is offline during the batch.
- The Active Directory directory service is offline.
- Mailboxes are moved.
- The message database (MDB) is offline.
- A password is expired.
- A quota is exceeded.
Error
Describes a request that cannot be fulfilled.

The following are some possible causes for errors:

- Invalid attributes or elements
- Attributes or elements out of range
- Unknown tag
- Attribute or element not valid in the context
- Unauthorized access attempt by any client
- Server-side failure in response to a valid client-side call

Information about the error can be found in the ResponseCode and MessageText elements.

Child elements

Element Description
MessageText
Provides a text description of the status of the response.
ResponseCode
Provides an error code that identifies the specific error that the request encountered.
DescriptiveLinkKey
Currently unused and is reserved for future use. It contains a value of 0.
MessageXml
Provides additional error response information.

Parent elements

Element Description
FreeBusyResponse
Contains the free/busy information for a single mailbox user.

The following is the XPath 2.0 expression to this element:

/GetUserAvailabilityResponse/FreeBusyResponseArray[i]/FreeBusyResponse
SuggestionsResponse
Contains response information and suggestion data for requested meeting suggestions.

The following is the XPath 2.0 expression to this element:

/GetUserAvailabilityResponse/SuggestionsResponse
GetUserOofSettingsResponse
Contains the response results and the OOF settings for a user.

The following is the XPath 2.0 expression to this element:

/GetUserOofSettingsResponse
SetUserOofSettingsResponse
Contains the result of an attempted SetUserOofSettingsRequest message.

The following is the XPath 2.0 expression to this element:

/SetUserOofSettingsResponse

Remarks

The ResponseMessageType type is common to all Exchange Web Services responses. The ResponseMessageType type is extended by the following complex types:

  • ApplyConversationActionResponseMessageType

  • AttachmentInfoResponseMessageType

  • DeleteAttachmentResponseMessageType

  • DeleteItemResponseMessageType

  • ExpandDLResponseMessageType

  • FindFolderResponseMessageType

  • FindItemResponseMessageType

  • FolderInfoResponseMessageType

  • GetEventsResponseMessageType

  • ItemInfoResponseMessageType

  • ResolveNamesResponseMessageType

  • SubscribeResponseMessageType

  • SendNotificationResponseMessageType

  • SyncFolderHierarchyResponseMessageType

  • SyncFolderItemsResponseMessageType

The schema that describes this element is located in the EWS virtual directory of the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

Version differences

The ApplyConversationActionResponseMessage and DeleteItemResponseMessageType types were introduced in Exchange build 15.00.0986.00.

Element information

Element Example
Namespace
http://schemas.microsoft.com/exchange/services/2006/messages
Schema Name
Messages schema
Validation File
Messages.xsd
Can be Empty
False

See also