QueryScheduleRequest QueryScheduleRequest QueryScheduleRequest QueryScheduleRequest Class

Definition

Contains the data that is needed to search the specified resource for an available time block that matches the specified parameters.

For the Web API use the QuerySchedule Function.

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

Examples

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.


// Get the current user's information.
           var userRequest = new WhoAmIRequest();
               var userResponse = (WhoAmIResponse)svc.Execute(userRequest);

// Retrieve the working hours of the current user.
var scheduleRequest = new QueryScheduleRequest { ResourceId = userResponse.UserId, Start = DateTime.Now, End = DateTime.Today.AddDays(7), TimeCodes = new TimeCode[] { TimeCode.Available } }; var scheduleResponse = (QueryScheduleResponse)svc.Execute(scheduleRequest);

// Verify if some data is returned for the availability of the current user if (scheduleResponse.TimeInfos.Length > 0) { Console.WriteLine("Successfully queried the working hours of the current user."); }

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.

// Get the current user's information.
                    WhoAmIRequest userRequest = new WhoAmIRequest();
                    WhoAmIResponse userResponse = (WhoAmIResponse)_serviceProxy.Execute(userRequest);
                // Retrieve the working hours of the current user.                                              
                QueryScheduleRequest scheduleRequest = new QueryScheduleRequest
                {
                    ResourceId = userResponse.UserId,
                    Start = DateTime.Now,
                    End = DateTime.Today.AddDays(7),
                    TimeCodes = new TimeCode[] { TimeCode.Available }
                };
                QueryScheduleResponse scheduleResponse = (QueryScheduleResponse)_serviceProxy.Execute(scheduleRequest);

                // Verify if some data is returned for the availability of the current user
                if (scheduleResponse.TimeInfos.Length > 0)
                {
                    Console.WriteLine("Successfully queried the working hours of the current user.");
                }</code></pre>

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the QueryScheduleResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Resource entity and access rights on the specified record in the ResourceId property. For a list of the required privileges, see QuerySchedule message privileges.

Notes for Callers

This request class is similar to the QueryMultipleSchedulesRequest class; however, this class searches for only one resource at a time.

Constructors

QueryScheduleRequest() QueryScheduleRequest() QueryScheduleRequest() QueryScheduleRequest()

Initializes a new instance of the QueryScheduleRequest class.

Properties

End End End End

Gets or sets the end of the time slot.

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)
ResourceId ResourceId ResourceId ResourceId

Gets or sets the ID of the resource.

Start Start Start Start

Gets or sets the start of the time slot.

TimeCodes TimeCodes TimeCodes TimeCodes

Gets or sets the time codes to look for: Available, Busy, Unavailable, or Filter.

Applies to

See also