BatchError Data Object - Bulk

  • Article

Defines a Bulk batch error object that identifies the item within the batch of items in the request message that caused the operation to fail, and describes the reason for the failure.

Syntax

<xs:complexType name="BatchError" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Code" type="xs:int" />
    <xs:element minOccurs="0" name="Details" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="FieldPath" nillable="true" type="xs:string" />
    <xs:element xmlns:q3="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q3:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Index" type="xs:int" />
    <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The BatchError object has the following elements: Code, Details, ErrorCode, FieldPath, ForwardCompatibilityMap, Index, Message, Type.

Element Description Data Type
Code A numeric error code that identifies the error. int
Details A message that provides additional details about the batch error. This string can be empty. string
ErrorCode A symbolic string constant that identifies the error. For example, UserIsNotAuthorized. string
FieldPath Reserved for future use. string
ForwardCompatibilityMap The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. KeyValuePairOfstringstring array
Index The zero-based index of the item in the batch of items in the request message that failed. int
Message A message that describes the error.

For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes.		 string
Type Reserved for future use. string

Requirements

Service: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

ApiFaultDetail