ApiFault Data Object - Customer Management

Article
03/20/2023

Defines a Customer Management 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="ApiFault" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q1="https://adapi.microsoft.com" base="q1:ApplicationFault">
      <xs:sequence>
        <xs:element minOccurs="0" name="OperationErrors" nillable="true" type="tns:ArrayOfOperationError" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The ApiFault object has the following elements: OperationErrors.

Element	Description	Data Type
OperationErrors	An array of OperationError objects 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 ApiFault object has Inherited Elements.

Inherited Elements

Inherited Elements from ApplicationFault

The ApiFault object derives from the ApplicationFault object, and inherits the following elements: TrackingId. The descriptions below are specific to ApiFault, 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: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Exception

Share via