SOAP Faults

The Capacity Management API returns standard SOAP faults in case of errors.

Soap Fault Fields

Soap Fault field	Possible values of this field	Description
faultcode	Client Server	This field is always returned. Client – means that the problem is with the request – either request has incorrect format, or invalid authentication info is supplied etc. Server – means that the problem is on Oracle Field Service side.
faultstring	Authentication Failed Unknown location Bad request format etc	This field is always returned. It contains human-readable description of error
faultactor	DISPATCHER get_capacity <absent>	This field is optional. This field is for diagnostic purposes and may be ignored by the Client Application. It signifies which part of Oracle Field Service system generated the Soap Fault.
detail	element containing children: errorCode, errorDetail	This field is optional. This field contains Oracle Field Service specific subfields: errorCode, errorDetail.
detail/errorCode	integer	This field is optional. When present, it contains one of error codes listed in Error Codes This field is meant to be machine-readable and meaning of existing error codes will not change. When this field is absent – it is because the request did not reach the destination endpoint. For example – failed due to invalid xml in request, or the destination service is temporary not available.
detail/errorDetail	string	This field is optional. When present, it contains additional information related to errorCode and faultstring. For example, when errorCode is '8' and faultstring is 'Unknown location' the errorDetail field contains the label of capacity bucket which was passed in the request.

SOAP Fault Example

<?xml version="1.0"?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
	<SOAP-ENV:Body> 
		<SOAP-ENV:Fault> 
			<faultcode>SOAP-ENV:Client</faultcode> 
			<faultstring>Unknown location</faultstring> 
			<faultactor>get_capacity</faultactor> 
			<detail> 
				<errorCode>8</errorCode> 
				<errorDetail>routi2ng</errorDetail> 
			</detail> 
		</SOAP-ENV:Fault> 
	</SOAP-ENV:Body> 
</SOAP-ENV:Envelope>