Operação FindPeople
Encontre informações sobre a operação FindPeople EWS.
A operação FindPeople retorna todos os objetos persona de uma pasta Contatos especificada ou recupera contatos que correspondem a uma cadeia de caracteres de consulta especificada.
This operation was introduced in Exchange Server 2013.
Usando a operação FindPeople
A operação FindPeople retorna informações de contato agregadas.
A operação FindPeople baseia-se na funcionalidade existente dos tipos complexos Restriction e BaseShape adicionando uma restrição de agregação e a capacidade de retornar propriedades adicionais. Usando uma restrição, um cliente pode especificar filtros como "somente retornar resultados que tenham um endereço de IM". O comportamento de pesquisa padrão tem como destino a caixa de correio pessoal do usuário especificada e a GAL (lista de endereços global). Ao pesquisar a GAL como a pasta de pesquisa primária, você deve especificar uma cadeia de caracteres de consulta em vez de uma restrição, pois essa operação não permite a navegação da GAL.
Cabeçalhos SOAP da operação FindPeople
A operação FindPeople pode usar os cabeçalhos SOAP listados na tabela a seguir.
Nome de cabeçalho | Elemento | Descrição |
---|---|---|
Representação |
ExchangeImpersonation |
Identifica o usuário que o aplicativo cliente está representando. Esse cabeçalho é aplicável a uma solicitação. |
RequestVersion |
RequestServerVersion |
Identifica a versão do esquema para a solicitação de operação. Esse cabeçalho é aplicável a uma solicitação. |
Serverversion |
ServerVersionInfo |
Identifica a versão do servidor que respondeu à solicitação. Esse cabeçalho é aplicável a uma resposta. |
Exemplo de solicitação de operação FindPeople
O exemplo a seguir de uma solicitação de operação FindPeople mostra como retornar os primeiros 100 contatos da pasta Contatos.
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope 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="Exchange2013" />
</soap:Header>
<soap:Body>
<m:FindPeople>
<m:IndexedPageItemView BasePoint="Beginning" MaxEntriesReturned="100" Offset="0"/>
<m:ParentFolderId>
<t:DistinguishedFolderId Id="contacts"/>
</m:ParentFolderId>
</m:FindPeople>
</soap:Body>
</soap:Envelope>
O corpo SOAP de solicitação contém os seguintes elementos:
O exemplo a seguir de uma solicitação de operação FindPeople mostra como retornar os primeiros 100 contatos da GAL usando uma cadeia de caracteres de consulta. Definir o DistinguishedFolderId como "diretório" pesquisará a GAL como a fonte primária de personas.
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope 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="Exchange2013" />
</soap:Header>
<soap:Body>
<m:FindPeople>
<m:PersonaShape>
<t:BaseShape>IdOnly</t:BaseShape>
<t:AdditionalProperties>
<t:FieldURI FieldURI="persona:DisplayName"/>
<t:FieldURI FieldURI="persona:Title"/>
</t:AdditionalProperties>
</m:PersonaShape>
<m:IndexedPageItemView BasePoint="Beginning" MaxEntriesReturned="100" Offset="0"/>
<m:ParentFolderId>
<t:DistinguishedFolderId Id="directory"/>
</m:ParentFolderId>
<m:QueryString>adams</m:QueryString>
</m:FindPeople>
</soap:Body>
</soap:Envelope>
Resposta bem-sucedida da operação FindPeople
O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação de operação FindPeople .
<?xml version="1.0" encoding="utf-8"?><s:Envelope
xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="349"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" />
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<FindPeopleResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<People>
<Persona xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<PersonaId Id="AAQkAGQ1MjJjMTBkLTc4Y2UtNDA5Ny04ZjU5LWI3MTYzNGNkZmRkYQAQAOjFqObcLmtOlzlRnHdXQjo=" />
<CreationTime>2012-01-11T22:25:37Z</CreationTime>
<DisplayName>Terry Adams</DisplayName>
<DisplayNameFirstLast>Terry Adams</DisplayNameFirstLast>
<DisplayNameLastFirst>Adams Terry</DisplayNameLastFirst>
<FileAs>Adams, Terry</FileAs>
<GivenName>Terry</GivenName>
<Surname>Adams</Surname>
<EmailAddress>
<Name>terry@litwareinc.com</Name>
<EmailAddress>terry@litwareinc.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
<EmailAddresses>
<EmailAddress>
<Name>terry@litwareinc.com</Name>
<EmailAddress>terry@litwareinc.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
<EmailAddress>
<Name>tadams@contoso.com</Name>
<EmailAddress>tadams@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
</EmailAddresses>
<RelevanceScore>2147483647</RelevanceScore>
</Persona>
</People>
<TotalNumberOfPeopleInView>1</TotalNumberOfPeopleInView>
</FindPeopleResponse>
</s:Body>
</s:Envelope>
O corpo SOAP de resposta contém os seguintes elementos:
Resposta de erro da operação FindPeople
Para códigos de erro genéricos para EWS, consulte ResponseCode.