2.2.2.4 Faults
This protocol allows a server to notify a client of application-level faults by generating SOAP faults by using the following XML syntax.
It does this by throwing a SOAP fault (as specified in [SOAP1.1] section 4.4) with XML, which MUST have the following format in the faults "detail" element.
<ErrorCode>errorCode</ErrorCode>
<Message>message</Message>
<ID>id</ID>
<Method>method</Method>
errorCode: Identifies the type of exception being thrown, the value of which MUST be one of those in the following table. The Description column in the table below defines possible actions that the client SHOULD take in response to the error.
message: An ErrorCode-specific user friendly string. This MAY be omitted.
id: A server-generated GUID that uniquely identifies the particular instance of this fault. This can be used to look up additional diagnostic data about the fault in a log, for example.
-
ErrorCode
Description
InvalidCookie
The server cannot decrypt the cookie to validate it. The client MUST discard the cookie and start the initial handshake again by calling GetConfig (section 2.2.2.2.1), GetAuthorizationCookie (section 2.2.2.1.1), GetCookie (section 2.2.2.2.2), and RefreshCache (section 2.2.2.2.5).
ConfigChanged
The server configuration has changed since the last time the client called GetConfig (section 2.2.2.2.1). The client MUST call GetConfig, GetAuthorizationCookie (section 2.2.2.1.1), and GetCookie (section 2.2.2.2.2) again.
RegistrationRequired
Client registration is required. The client SHOULD call RegisterComputer (section 2.2.2.2.3) before calling SyncUpdates (section 2.2.2.2.4) again.
ServerChanged
The server's identity or state has changed. The client MUST discard the cookie and start the initial handshake again by calling GetConfig (section 2.2.2.2.1), GetAuthorizationCookie (section 2.2.2.1.1), GetCookie (section 2.2.2.2.2), and RefreshCache (section 2.2.2.2.5).
InternalServerError
An internal error has occurred in the server while processing the request. The client SHOULD try the failed operation again later.
CookieExpired
The client is using an expired cookie that the server is able to decrypt. It MUST call GetAuthorizationCookie (section 2.2.2.1.1) and GetCookie (section 2.2.2.2.2) again to renew its expired cookie.
InvalidParameters
The client has passed invalid parameters to the server. The "message" part of the exception will contain the parameter name.
InvalidAuthorizationCookie
The authorization cookie passed to GetCookie (section 2.2.2.2.2) is invalid.
RegistrationNotRequired
The client has called RegisterComputer (section 2.2.2.2.3) even though the server told it not to in the GetConfig (section 2.2.2.2.1) response.
ServerBusy
The server is too busy to handle this request. The client SHOULD try again later.
FileLocationChanged
The file locations have changed since the last time the client synced. The client SHOULD call GetFileLocations (section 2.2.2.2.7) to get the current file locations.
method: A string indicating the web service method in which the fault occurred. This can be omitted.