ServiceAppointment entity messages and methods

 

Applies To: Dynamics CRM 2013

The service appointment entity represents a block of time on a calendar. This entity stores the availability blocks for resources and can be used to determine resource availability and scheduling. The schema name for this entity is ServiceAppointment. 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
AssignRequest	Assigns a service appointment to another user or team.
BookRequest	Schedules or books a service appointment.
CreateRequest	Creates a service appointment. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a service appointment. You can also call the IOrganizationService.Delete method.
GrantAccessRequest	Shares a service appointment with another security principal (user or team).
ModifyAccessRequest	Changes the access rights for a service appointment previously shared with another security principal (user or team).
RescheduleRequest	Reschedules a service appointment.
RetrieveRequest	Retrieves a service appointment. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of service appointments. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access that the specified security principal (user or team) has to a service appointment.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a service appointment, together with their access rights to the service appointment.
RevokeAccessRequest	Removes all access to a service appointment for the specified security principal (user or team).
SearchRequest	Searches for available time slots that fulfill the specified appointment request.
SetStateRequest	Sets the state of a service appointment. The possible values for this attribute are defined in the ServiceAppointment.State attribute.If you are using early bound types, you can use the ServiceAppointmentState enumeration. For a list of states, ServiceAppointment entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates a service appointment. You can also call the IOrganizationService.Update method.
ValidateRequest	Validates that all the constraints of a service appointment are met.

See Also

Appointment entities
Schedule and appointment entities
ServiceAppointment (service activity) entity privileges