日本語のコンテンツは機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は保証できません。英語版が正となります。また、現時点では検索機能は日本語での検索をサポートしていません。翻訳に関するフィードバックについては、docs@zuora.comに送信してください。

US Data Center Customers: The SOAP API is no longer under active development. The legacy SOAP calls still function, but are now also available in REST.
EU Data Center Customers: The SOAP API is not available. Please use the REST API.
APAC Data Center Customers: The SOAP API is not available. Please use the REST API.
Going forward, new features will only be available through the REST API. We strongly recommend that all integrations are done using the REST API.
You can find the REST API documentation at https://www.zuora.com/developer/.

Faults

Last updated

Jan 8, 2020
Save as PDF

Overview

A fault is a fatal, call-level error. Faults differ from errors, which cause only part of a call to fail. When a fault occurs, the call fails completely and nothing is processed. Examples of faults include an incorrect ZOQL statement, an invalid authentication, and a server error.

Fault elements

When a fault occurs, the call fails entirely, nothing is processed, and a fault is returned.

Fault	Description
`ApiFault`	The base fault. This fault has a fault code (`FaultCode`) and a fault message (`FaultMessage`). The `FaultCode` points to the appropriate `ErrorCode`. If you make a call that results in a fault, then the call returns an exception with the `ErrorCode`, which tells you what happened. The `FaultMessage` is a string that provides details about the fault.
`InvalidQueryLocatorFault`	The query locator expired or was otherwise invalid.
`InvalidTypeFault`	An invalid type, unknown type, or a type not supported in the API version was specified.
`InvalidValueFault`	An invalid value was specified.
`LoginFault`	The specified login credentials were invalid. Log in again.
`MalformedQueryFault`	The query string used an invalid format or syntax, or the string exceeds the maximum length of a query statement. The maximum length of a query string in 10,000 characters.
`UnexpectedErrorFault`	There was an unexpected problem with the call. No further details are available.

Restricted Access Message

If your tenant has specified allowable IP address ranges for Zuora, the following fault response is returned when a call is sent from an IP address outside the specified range. Contact your tenant administrator for assistance.

01<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
02   <soapenv:Body>
03      <soapenv:Fault xmlns:fns="http://fault.api.zuora.com/">
04         <faultcode>fns:INVALID_VALUE</faultcode>
05         <faultstring>Your IP address may be restricted. Please contact the administrator at your company for help.</faultstring>
06         <detail>
07            <fns:LoginFault>
08               <fns:FaultCode>INVALID_VALUE</fns:FaultCode>
09               <fns:FaultMessage>Your IP address may be restricted. Please contact the administrator at your company for help.</fns:FaultMessage>
10            </fns:LoginFault>
11         </detail>
12      </soapenv:Fault>
13   </soapenv:Body>
14</soapenv:Envelope>