Share via


AppointmentRequest ComplexType

 

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

Provides the details of an appointment request for the Search function.

This Web API complex type corresponds to the organization service AppointmentRequest.

Properties

The properties of a complex type contain the structured data of the type.

Name

Type

Nullable

Unicode

Description

AnchorOffset

Edm.Int32

The time offset in minutes, from midnight, when the first occurrence of the appointment can take place.

AppointmentsToIgnore

Collection(AppointmentsToIgnore ComplexType)

The appointments to ignore in the search for possible appointments.

Constraints

Collection(ConstraintRelation ComplexType)

Any additional constraints.

Direction

SearchDirection EnumType

The direction of the search.

Duration

Edm.Int32

The appointment duration, in minutes.

NumberOfResults

Edm.Int32

The number of results to be returned from the search request.

Objectives

Collection(ObjectiveRelation ComplexType)

The scheduling strategy that overrides the default constraints.

RecurrenceDuration

Edm.Int32

The time, in minutes, for which the appointment recurrence is valid.

RecurrenceTimeZoneCode

Edm.Int32

A value to override the time zone that is specified by the UserTimeZoneCode property.

RequiredResources

Collection(RequiredResource ComplexType)

The resources that are needed for this appointment.

SearchRecurrenceRule

Edm.String

false

The recurrence rule for appointment recurrence.

SearchRecurrenceStart

Edm.DateTimeOffset

The date and time for the first possible instance of the appointment.

SearchWindowEnd

Edm.DateTimeOffset

The date and time to end the search.

SearchWindowStart

Edm.DateTimeOffset

The date and time to begin the search.

ServiceId

Edm.Guid

The ID of the service to search for.

Sites

Collection(Edm.Guid)

false

The sites where the requested appointment can take place.

UserTimeZoneCode

Edm.Int32

The time zone code of the user who is requesting the appointment.

Types that use the AppointmentRequest complex type.

The following use the AppointmentRequest complex type.

Name

How used

Description

Search Function

AppointmentRequest Parameter

Searches for available time slots that fulfill the specified appointment request.

See Also

Use the Microsoft Dynamics 365 Web API
Web API EntityType Reference
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright