Click or drag to resize
Failure Class
Contains details of a failure in the server-side processing of all or part of an API request.
Inheritance Hierarchy
SystemObject
  DegreeDays.ApiFailure

Namespace: DegreeDays.Api
Assembly: DegreeDaysApi (in DegreeDaysApi.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax
public sealed class Failure

The Failure type exposes the following members.

Methods
Properties
  NameDescription
Public propertyCode
Gets the non-null, non-empty code associated with this failure.
Public propertyMessage
Gets the non-null message associated with this failure, providing explanatory information about the Code and what went wrong.
Top
Remarks

A failure is primarily defined by its Code. But it also comes with a Message to help explain the meaning of the code.

You are unlikely to need to deal with Failure objects or failure codes directly, as API methods like GetLocationData(LocationDataRequest) and GetBase(DataSpec) will automatically turn any failure codes into appropriate subclasses of FailureException.

Thread Safety
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
See Also