3.1.4.1.3.24 t:SuggestionsViewOptionsType Complex Type

  • Article

The SuggestionsViewOptionsType complex type specifies the options for obtaining meeting suggestion information.

 <xs:complexType name="SuggestionsViewOptionsType">
   <xs:sequence>
     <xs:element name="GoodThreshold"
       type="xs:int"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="MaximumResultsByDay"
       type="xs:int"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="MaximumNonWorkHourResultsByDay"
       type="xs:int"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="MeetingDurationInMinutes"
       type="xs:int"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="MinimumSuggestionQuality"
       type="t:SuggestionQuality"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="DetailedSuggestionsWindow"
       type="t:Duration"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="CurrentMeetingTime"
       type="xs:dateTime"
       maxOccurs="1"
       minOccurs="0"
      />
     <xs:element name="GlobalObjectId"
       type="xs:string"
       maxOccurs="1"
       minOccurs="0"
      />
   </xs:sequence>
 </xs:complexType>
 

The following table lists the child elements of the SuggestionsViewOptionsType complex type.

Element name

Type

Description

GoodThreshold

xs:int [XMLSCHEMA2]

Determines whether the suggestion is considered Good or Fair. The suggested meeting time is considered Excellent if there are no conflicts. The suggested meeting time is considered Poor if the percentage of conflicts is greater than 50 percent. The suggested meeting time is considered Good if the percentage of conflicts is less than the GoodThreshold element value. The suggested meeting time is considered Fair if the percentage of conflicts is greater than the GoodThreshold element value, but less than or equal to 50 percent.

Can be present.

If present, the value MUST be an integer >= 1 and <= 49.

The default value is 25.

MaximumResultsByDay

xs:int

Specifies the number of suggested meeting times per day that are returned in the response.

Can be present. If present, MUST be an integer <= 48. If the value is <= 0, MUST return an empty SuggestionArray element in the response.

The default value is 24.

MaximumNonWorkHourResultsByDay

xs:int

Specifies the number of suggested results for meeting times outside the regular working hours of the organizer per day.

Can be present; if present, MUST be an integer >= 1 and <= 48.

The default value is 0 (zero).

MeetingDurationInMinutes

xs:int

Specifies the length in minutes of the meeting to be suggested.

Can be present. If present, MUST be an int >= 1 and <= 1440.

The default value is 30.

MinimumSuggestionQuality

t:SuggestionQuality (section 3.1.4.1.4.3)

Specifies the minimum quality of meeting suggestions that are to be returned in the response.

Can be present.

The default value is "Fair".

DetailedSuggestionsWindow

t:Duration ([MS-OXWSCDATA] section 2.2.4.28)

Specifies the time span that is queried for detailed information about suggested meeting times.

Though the element is specified as minOccurs = 0, the DetailedSuggestionsWindow element MUST be present.

StartTime and EndTime fields have dates only and no time information present in the DateTime data type.

CurrentMeetingTime

xs:dateTime [XMLSCHEMA2]

Represents the start time of a meeting that you want to update with the suggested meeting time results.

Can be present.

GlobalObjectId

xs:string [XMLSCHEMA2]

Represents the global object ID (the PidLidGlobalObjectId property, as specified in [MS-OXOCAL] section 2.2.1.27) of the calendar item that is to be ignored while calculating suggestions.

Can be present.