Share via

3.1.4.2.3.1 m:GetMessageTrackingReportRequestType Complex Type

  • Article

The GetMessageTrackingReportRequestType complex type specifies details for the type of report to retrieve. The GetMessageTrackingReportRequestType complex type extends the BaseRequestType complex type ([MS-OXWSCDATA] section 2.2.4.17).

 <xs:complexType name="GetMessageTrackingReportRequestType">
   <xs:complexContent>
     <xs:extension
       base="m:BaseRequestType"
     >
       <xs:all>
         <xs:element name="Scope"
           type="t:NonEmptyStringType"
          />
         <xs:element name="ReportTemplate"
           type="t:MessageTrackingReportTemplateType"
          />
         <xs:element name="RecipientFilter"
           type="t:EmailAddressType"
           minOccurs="0"
          />
         <xs:element name="MessageTrackingReportId"
           type="t:NonEmptyStringType"
          />
         <xs:element name="ReturnQueueEvents"
           type="xs:boolean"
           minOccurs="0"
          />
         <xs:element name="DiagnosticsLevel"
           type="xs:string"
           minOccurs="0"
          />
         <xs:element name="Properties"
           type="t:ArrayOfTrackingPropertiesType"
           minOccurs="0"
          />
       </xs:all>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 

The following table lists and describes the child elements of the GetMessageTrackingReportRequestType complex type.

Element name

Type

Description

Scope

t:NonEmptyStringType ([MS-OXWSCDATA] section 2.2.5.20)

Specifies where to perform the search.<14>

ReportTemplate

t:MessageTrackingReportTemplateType (section 3.1.4.2.1.1)

Specifies the type of tracking report to retrieve.

RecipientFilter

t:EmailAddressType ([MS-OXWSCDATA] section 2.2.4.31)

Specifies a recipient address to use with the specified tracking report. If the ReportTemplate element is set to "RecipientPath", this element MUST be present.

MessageTrackingReportId

t:NonEmptyStringType

Specifies an identity string that was obtained from the FindMessageTrackingReport operation (section 3.1.4.1).

ReturnQueueEvents

xs:boolean ([XMLSCHEMA2])

Specifies that the person who is running the task has a privileged role.

DiagnosticsLevel

xs:string ([XMLSCHEMA2])

Specifies timing and performance information that will be used to derive the tracking report.

Properties

t:ArrayOfTrackingPropertiesType (section 2.2.4.2)

Specifies a list of one or more tracking properties.<15>

The following table lists and describes the values of the DiagnosticsLevel element.

Value name

Description

None

Diagnostics logging is disabled.

Basic

Basic diagnostics are collected and returned in web response.

Verbose

Basic diagnostics plus verbose logging (Such as the result that was returned through web service). The traces are returned in web response.

Etw

Turn on event tracing for windows, in addition to Verbose diagnostics. The verbose traces are returned in the web response. The event tracing for windows are written locally on the server and will not be returned in the web response.

The values of the DiagnosticsLevel element are case sensitive. If the value is set as the any value except above 4 values, the server will treat it as None.