BookRequest BookRequest BookRequest BookRequest Class

Definition

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

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

Examples



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

// Create the ActivityParty instance.
var party = new ActivityParty
{
    PartyId = new EntityReference(SystemUser.EntityLogicalName, userResponse.UserId)
};
// Create the appointment instance.
var 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.
var book = new BookRequest
{
    Target = appointment
};

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

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.

ScheduleAndAppointment#BookAppointment1

Remarks

Message Availability

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

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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.

Entity

Availability

appointment

Server

recurringappointmentmaster

Server

serviceappointment

Server

Constructors

BookRequest() BookRequest() BookRequest() BookRequest()

Initializes a new instance of the BookRequest Class.

Properties

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

For internal use only.

Target Target Target Target

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

Applies to

See also