Appointment entity messages and methods

 

Applies To: Dynamics CRM 2013

The appointment entity represents a block of time on a calendar. This includes blocking of the availability for included resources. The schema name for this entity is Appointment. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AddRecurrenceRequest	Adds recurrence information to an existing appointment to make it a recurring appointment master.
AssignRequest	Assigns an appointment to another user or team.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the Appointment entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
BookRequest	Schedules or books an appointment.
CreateRequest	Creates an appointment. You can also call the IOrganizationService.Create method.
CreateExceptionRequest	Creates an exception for the recurring appointment instance Appointment.InstanceTypeCode. For more information, see Create a recurring appointment exception.
DeleteRequest	Deletes an appointment. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the Appointment entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
GrantAccessRequest	Shares an appointment with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
ModifyAccessRequest	Changes the access rights for an appointment previously shared with another security principal (user or team).
RescheduleRequest	Reschedules an appointment.
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves an appointment. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of appointments. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access that the specified security principal (user or team) has to an appointment.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to an appointment, and also retrieves their access rights to the appointment.
RevokeAccessRequest	Removes all access to an appointment for the specified security principal (user or team).
SetStateRequest	Sets the state of an appointment. The possible values for this attribute are defined in the Appointment.State attribute. If you are using early bound types, you can use the AppointmentState enumeration. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates an appointment. You can also call the Update method.
ValidateRequest	Validates that all the constraints of an appointment are met.

See Also

Appointment entities
Recurring appointment entities
Schedule and appointment entities
ServiceAppointment entity messages and methods
Appointment entity privileges