QueryMultipleSchedulesRequest Class

  • Reference

Definition

Namespace:
Microsoft.Crm.Sdk.Messages
Assembly:
Microsoft.Crm.Sdk.Proxy.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Contains the data that is needed to search multiple resources for available time block that match the specified parameters. 

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

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 instance. For the complete sample, see the link later in this topic.

// Retrieve the working hours of the current and the other user.                                              
QueryMultipleSchedulesRequest scheduleRequest = new QueryMultipleSchedulesRequest();
scheduleRequest.ResourceIds = new Guid[2];
scheduleRequest.ResourceIds[0] = _currentUserId;
scheduleRequest.ResourceIds[1] = _otherUserId;
scheduleRequest.Start = DateTime.Now;
scheduleRequest.End = DateTime.Today.AddDays(7);
scheduleRequest.TimeCodes = new TimeCode[] { TimeCode.Available };

QueryMultipleSchedulesResponse scheduleResponse = (QueryMultipleSchedulesResponse)_serviceProxy.Execute(scheduleRequest);

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

Remarks

For the Web API use the QueryMultipleSchedules function.

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

Privileges and Access Rights

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

Notes for Callers

This class functions similarly to the QueryScheduleRequest class, except that this class searches for multiple resources at one time.

Constructors

QueryMultipleSchedulesRequest()

Initializes a new instance of the QueryMultipleSchedulesRequest class.

Properties

End

Gets or sets the end time for the scheduled block of time. Required.
ExtensionData

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

(Inherited from OrganizationRequest)
Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters

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

(Inherited from OrganizationRequest)
RequestId

Gets or sets the ID of the request. Optional.

(Inherited from OrganizationRequest)
RequestName

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

(Inherited from OrganizationRequest)
ResourceIds

Gets or sets the IDs of the resources. Required.
Start

Gets or sets the start of the time slot. Required.
TimeCodes

Gets or sets the time codes to look for: Available, Busy, Unavailable, or Filter, which correspond to the resource IDs. Required.

Applies to

See also