Objeto de Dados ApiFault - Gestão de Clientes

Artigo
11/13/2024

Define um objeto de detalhe de falha da API de Gestão de Clientes que as operações devolvem quando ocorrem erros específicos do serviço Web, como quando a mensagem de pedido contém dados incompletos ou inválidos.

Sintaxe

XML
JSON

<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>

{
  "TrackingId": "ValueHere",
  "Type": "ApiFault",
  "OperationErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "Message": "ValueHere"
    }
  ]
}

Elementos

O objeto ApiFault tem os seguintes elementos: OperationErrors.

Elemento	Descrição	Tipo de Dados
OperationErrors	Uma matriz de objetos OperationError que contém os motivos pelos quais a operação de serviço falhou quando o erro não está relacionado com um item específico no lote de itens.	Matriz OperationError

O objeto ApiFault tem Elementos Herdados.

Elementos Herdados

Elementos Herdados de ApplicationFault

O objeto ApiFault deriva do objeto ApplicationFault e herda os seguintes elementos: TrackingId. As descrições abaixo são específicas do ApiFault e podem não se aplicar a outros objetos que herdam os mesmos elementos do objeto ApplicationFault .

Elemento	Descrição	Tipo de Dados
TrackingId	O identificador da entrada de registo que contém os detalhes da chamada à API.	cadeia

Requisitos

Serviço: CustomerManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Customer/v13/Exception

Partilhar via