SearchRequest SearchRequest SearchRequest SearchRequest Class

Definition

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

For the Web API use the Search Function.

public ref class SearchRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SearchRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type SearchRequest = class
    inherit OrganizationRequest
Public NotInheritable Class SearchRequest
Inherits OrganizationRequest
Inheritance
Attributes

Examples

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

// Create the appointment request.
var 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              
var search = new SearchRequest
{
    AppointmentRequest = appointmentReq
};
SearchResponse searched = (SearchResponse)svc.Execute(search);

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

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.

ScheduleAndAppointment#ScheduleResource1 ScheduleAndAppointmentVB#ScheduleResource1

Remarks

Message Availability

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

Pass an instance of this class to the Execute(OrganizationRequest) 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.

Constructors

SearchRequest() SearchRequest() SearchRequest() SearchRequest()

Initializes a new instance of the SearchRequest class.

Properties

AppointmentRequest AppointmentRequest AppointmentRequest AppointmentRequest

Gets or sets the appointment request.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also