QueryScheduleRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

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

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.QueryScheduleRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class QueryScheduleRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class QueryScheduleRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type QueryScheduleRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class QueryScheduleRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	QueryScheduleRequest()	Initializes a new instance of the QueryScheduleRequest class.

Properties

	Name	Description
	End	Gets or sets the end of the time slot.
	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.)
	ResourceId	Gets or sets the ID of the resource.
	Start	Gets or sets the start of the time slot.
	TimeCodes	Gets or sets the time codes to look for: Available, Busy, Unavailable, or Filter.

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 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.

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.

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.