RetrieveDuplicatesRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to detect and retrieve duplicates for a specified record.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveDuplicatesRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveDuplicatesRequest : OrganizationRequest

Example

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

var request = new RetrieveDuplicatesRequest
{
    BusinessEntity = new Account { Name = "Microsoft" }.ToEntity<Entity>(),
    MatchingEntityName = Account.EntityLogicalName,
    PagingInfo = new PagingInfo() { PageNumber = 1, Count = 50 }
};

Console.WriteLine("Retrieving duplicates");
var response =(RetrieveDuplicatesResponse)_serviceProxy.Execute(request);

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveDuplicatesResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the entities and the access rights to the specified records in the BusinessEntity property.

For a complete list of the required privileges, see RetrieveDuplicates Privileges.

Notes to Callers

This message works for all entities. Before you use this message, set the IsDuplicateDetectionEnabled attribute for an entity to true and publish all duplicate detection rules for an entity.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.RetrieveDuplicatesRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

RetrieveDuplicatesRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveDuplicatesResponse

Other Resources

RetrieveDuplicates Privileges
Sample: Enable Duplicate Detection and Retrieve Duplicates
Detect Duplicate Data in Microsoft Dynamics CRM
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.