An informational object used to communicate errors to a client application.

Usage

A client application can use an LmsError object received from Firmwater LMS to identify what error occurred during the associated web service call. Several Firmwater LMS web service methods use LmsError objects as a means of returning error information. CreateOrUpdate returns arrays of LmsError objects within a SaveResult. Whenever an exception occurs during a web service call, Firmwater LMS serializes an LmsError object within the detail XML tag of a SOAP exception. It is up to the client application to deserialize the XML in order to determine the Firmwater LMS specific error.

Fields

ErrorCode

An enumerated list of Firmwater LMS error codes. Client applications can use error codes to programmatically handle errors. For example, during a Login call a user may enter incorrect authentication information; the client application can identify such an error returned by Firmwater LMS and prompt the user for the correct password. See StatusCode for a list of values and their descriptions.

ErrorMessage

A string used by Firmwater LMS to provide a more descriptive reason for the failure. An LmsError is not required to contain an error message; in cases where no error message is provided, the ErrorMessage field is set to empty string ("").