QueryMultipleSchedulesRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to search multiple resources for available time block that match the specified parameters.
For the Web API use the QueryMultipleSchedules Function.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.QueryMultipleSchedulesRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class QueryMultipleSchedulesRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class QueryMultipleSchedulesRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
QueryMultipleSchedulesRequest() | Initializes a new instance of the QueryMultipleSchedulesRequest class. |
Properties
Name | Description | |
---|---|---|
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 an asynchronous operation (system job). 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. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 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.
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.
// 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.");
}
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
QueryMultipleSchedulesResponse
Microsoft.Crm.Sdk.Messages Namespace
Schedules in Microsoft Dynamics 365
Sample: Query the working hours of multiple users
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright