SearchRequest Class


Contains the data needed to search for available time slots that fulfill the specified appointment request.

For the Web API use the Search Function.

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


[DataContractAttribute(Namespace = "")]
public sealed class SearchRequest : OrganizationRequest


Initializes a new instance of the SearchRequest class.


Gets or sets the appointment request.


Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)


Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)


Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)


Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


(Inherited from Object.)


(Inherited from Object.)


(Inherited from Object.)


(Inherited from Object.)

Message Availability

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

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

Privileges and Access Rights

For a list of the privileges required, see Search message privileges.

Notes for Callers

This message will return a set of available appointments as time blocks.

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.

// Create the van required resource object.
RequiredResource vanReq = new RequiredResource
    ResourceId = _vanId,
    ResourceSpecId = _specId

// Create the appointment request.
AppointmentRequest appointmentReq = new AppointmentRequest
    RequiredResources = new RequiredResource[] { vanReq },
    Direction = SearchDirection.Backward,
    Duration = 60,
    NumberOfResults = 10,
    ServiceId = _plumberServiceId,
    // The search window describes the time when the resouce can be scheduled.
    // It must be set.
    SearchWindowStart = DateTime.Now.ToUniversalTime(),
    SearchWindowEnd = DateTime.Now.AddDays(7).ToUniversalTime(),
    UserTimeZoneCode = 1

// Verify whether there are openings available to schedule the appointment using this resource              
SearchRequest search = new SearchRequest
    AppointmentRequest = appointmentReq
SearchResponse searched = (SearchResponse)_serviceProxy.Execute(search);

if (searched.SearchResults.Proposals.Length > 0)
    Console.WriteLine("Openings are available to schedule the resource.");

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

Return to top

Microsoft Dynamics CRM 2016 and CRM Online

© 2016 Microsoft. All rights reserved. Copyright

Community Additions