GetRooms operation
The GetRooms operation gets the rooms within the specified room list.
Note : Rooms which are marked "Hidden from GAL" can't be retrieved through this method.
The GetRooms operation can use the SOAP headers that are listed and described in the following table.
Header | Element | Description |
---|---|---|
Impersonation |
ExchangeImpersonation |
Identifies the user whom the client application is impersonating. |
MailboxCulture |
MailboxCulture |
Identifies the RFC3066 culture to be used to access the mailbox. |
RequestVersion |
RequestServerVersion |
Identifies the schema version for the operation request. |
ServerVersion |
ServerVersionInfo |
Identifies the version of the server that responded to the request. |
The following is an example of a GetRooms request that gets the rooms that are associated with a room list.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version ="Exchange2010_SP1"/>
</soap:Header>
<soap:Body>
<m:GetRooms>
<m:RoomList>
<t:EmailAddress>RoomList@contoso.com</t:EmailAddress>
</m:RoomList>
</m:GetRooms>
</soap:Body>
The following elements are used in the request:
The following response shows the email address information for the rooms that are associated with the room list.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="14" MinorVersion="1" MajorBuildNumber="164" MinorBuildNumber="0" Version="Exchange2010_SP1" xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetRoomsResponse ResponseClass="Success" xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<m:Rooms xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<t:Room xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<t:Id>
<t:Name>Room01</t:Name>
<t:EmailAddress>Room01@contoso.com</t:EmailAddress>
<t:RoutingType>SMTP</t:RoutingType>
<t:MailboxType>Mailbox</t:MailboxType>
</t:Id>
</t:Room>
<t:Room xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<t:Id>
<t:Name>Room02</t:Name>
<t:EmailAddress>Room02@contoso.com</t:EmailAddress>
<t:RoutingType>SMTP</t:RoutingType>
<t:MailboxType>Mailbox</t:MailboxType>
</t:Id>
</t:Room>
</m:Rooms>
</GetRoomsResponse>
</s:Body>
</s:Envelope>
The following elements are used in the response:
The following example shows an error response caused by an attempt to get room information for a nonexistent room list.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="14" MinorVersion="1" MajorBuildNumber="164" MinorBuildNumber="0" Version="Exchange2010_SP1" xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetRoomsResponse ResponseClass="Error" xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<MessageText>No results were found.</MessageText>
<ResponseCode>ErrorNameResolutionNoResults</ResponseCode>
<DescriptiveLinkKey>0</DescriptiveLinkKey>
</GetRoomsResponse>
</s:Body>
</s:Envelope>
The following elements are used in the response: