RetrieveLeadsRequest Class

 

Applies To: Dynamics Marketing

Contains the data that’s required to retrieve a list of leads.

Namespace:   Microsoft.Dynamics.Marketing.SDK.Messages.Lead
Assembly:  Microsoft.Dynamics.Marketing.SDK (in Microsoft.Dynamics.Marketing.SDK.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Dynamics.Marketing.SDK.Common.SdkMessage
    Microsoft.Dynamics.Marketing.SDK.Common.SdkRequest
      Microsoft.Dynamics.Marketing.SDK.Messages.Lead.RetrieveLeadsRequest

Syntax

[DataContractAttribute]
public class RetrieveLeadsRequest : SdkRequest
[DataContractAttribute]
public ref class RetrieveLeadsRequest : SdkRequest
[<DataContractAttribute>]
type RetrieveLeadsRequest = 
    class
        inherit SdkRequest
    end
<DataContractAttribute>
Public Class RetrieveLeadsRequest
    Inherits SdkRequest

Constructors

Name Description
System_CAPS_pubmethod RetrieveLeadsRequest()

Initializes a new instance of the RetrieveLeadsRequest class.

Properties

Name Description
System_CAPS_pubproperty BelongsToCompanyId

Gets or sets the ID of the company that the lead belongs to.

System_CAPS_pubproperty FromUpdateDate

Gets or sets the value indicating the first update for a lead to be included in the result list, expressed as the Coordinated Universal Time (UTC).

System_CAPS_pubproperty MaxNumberOfRecordsToGet

Gets or sets the maximum number of records to retrieve.

System_CAPS_pubproperty OriginOfChange

Gets or sets the origin of change value that the lead needs to have to be part of the result list.

System_CAPS_pubproperty SkipNumberOfRecords

Gets or sets the number of records, starting from the beginning of the results, to not return in the response.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod ToBrokeredMessage()

Creates a new brokered message with the compressed and serialized SdkMessage.(Inherited from SdkMessage.)

System_CAPS_pubmethod ToBrokeredMessage(String)

Creates a new brokered message with the compressed and serialized SdkMessage.(Inherited from SdkRequest.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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.

See Also

RetrieveLeadsResponse
Microsoft.Dynamics.Marketing.SDK.Messages.Lead Namespace
Developer overview of Microsoft Dynamics Marketing
Manage leads, contacts, and company
Getting started with the SDK
Quick start with sample code
Sample: Create, read, update, and delete lead (including UDF custom fields)
Assembly included in the Microsoft Dynamics Marketing SDK
Web service and assembly reference

Return to top