ApiFaultDetail Data Object - Reporting

Article
03/20/2023

Defines a Reporting API fault detail object that operations return when web service-specific errors occur, such as when the request message contains incomplete or invalid data.

Syntax

<xs:complexType name="ApiFaultDetail" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q28="https://adapi.microsoft.com" base="q28:ApplicationFault">
      <xs:sequence>
        <xs:element minOccurs="0" name="BatchErrors" nillable="true" type="tns:ArrayOfBatchError" />
        <xs:element minOccurs="0" name="OperationErrors" nillable="true" type="tns:ArrayOfOperationError" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The ApiFaultDetail object has the following elements: BatchErrors, OperationErrors.

Element	Description	Data Type
BatchErrors	An array of batch errors that identifies the items in the batch of items in the request message that caused the operation to fail. Each object contains the details that explain why the item caused the failure.	BatchError array
OperationErrors	An array of operation errors that contains the reasons that explain why the service operation failed when the error is not related to a specific item in the batch of items.	OperationError array

The ApiFaultDetail object has Inherited Elements.

Inherited Elements

Inherited Elements from ApplicationFault

The ApiFaultDetail object derives from the ApplicationFault object, and inherits the following elements: TrackingId. The descriptions below are specific to ApiFaultDetail, and might not apply to other objects that inherit the same elements from the ApplicationFault object.

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Requirements

Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13

Share via