BookRequest Class


Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to schedule or “book” an appointment, recurring appointment, or service appointment (service activity).

For the Web API use the Book Action.

Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class BookRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class BookRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod BookRequest()

Initializes a new instance of the BookRequest Class.


Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty ReturnNotifications

For internal use only.

System_CAPS_pubproperty Target

Gets or sets the record that is the target of the book operation. Required.


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

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


Pass an instance of this class to the Execute method, which returns an instance of the BookResponse class.

Privileges and Access Rights

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

Supported Entities

The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available.










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 information
WhoAmIRequest userRequest = new WhoAmIRequest();
WhoAmIResponse userResponse = (WhoAmIResponse)_serviceProxy.Execute(userRequest);

// Create the ActivityParty instance.
ActivityParty party = new ActivityParty
    PartyId = new EntityReference(SystemUser.EntityLogicalName, userResponse.UserId)

// Create the appointment instance.
Appointment appointment = new Appointment
    Subject = "Test Appointment",
    Description = "Test Appointment created using the BookRequest Message.",
    ScheduledStart = DateTime.Now.AddHours(1),
    ScheduledEnd = DateTime.Now.AddHours(2),
    Location = "Office",
    RequiredAttendees = new ActivityParty[] { party },
    Organizer = new ActivityParty[] { party }                        

// Use the Book request message.
BookRequest book = new BookRequest
    Target = appointment
BookResponse booked = (BookResponse)_serviceProxy.Execute(book);
_appointmentId = booked.ValidationResult.ActivityId;

// Verify that the appointment has been scheduled.
if (_appointmentId != Guid.Empty)
    Console.WriteLine("Succesfully booked {0}.", appointment.Subject) ;

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

Microsoft.Crm.Sdk.Messages Namespace
Schedule and appointment entities
Create a recurring appointment series
Sample: Book an appointment

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright