ApiBatchFault Data Object - Customer Billing

Article
03/20/2023

Defines a Customer Billing API batch fault 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="ApiBatchFault" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ApiFault">
      <xs:sequence>
        <xs:element minOccurs="0" name="BatchErrors" nillable="true" type="tns:ArrayOfBatchError" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The ApiBatchFault object has the following elements: BatchErrors.

Element	Description	Data Type
BatchErrors	An array of BatchError objects 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

The ApiBatchFault object has Inherited Elements.

Inherited Elements

Inherited Elements from ApiFault

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

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

Inherited Elements from ApplicationFault

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

Share via