Show / Hide Table of Contents

Class EthosError

An Ellucian Ethos Integration Error object.

Inheritance
System.Object
EthosError
Namespace: Ellucian.Ethos.Integration.Client.Errors
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public class EthosError : object

Constructors

EthosError(String, String, Int32, String, String, String, String, String, String, String, Resource, Request)

An Ellucian Ethos Integration Error object.

Declaration
public EthosError(string id, string severity, int responseCode, string description, string details, string applicationId, string applicationName, string dateTime, string correlationId, string applicationSubType, Resource resource, Request request)
Parameters
Type Name Description
System.String id

A GUID for this error.

System.String severity

(required) The severity of this error. This should be one of info, warning, or error.

System.Int32 responseCode

(required) An integer response code associated with this error.

System.String description

(required) A description for this error.

System.String details

A detailed message for this error.

System.String applicationId

The ID of the application reporting this error.

System.String applicationName

The name of the application reporting this error.

System.String dateTime

The Date that the error occurred.

System.String correlationId

The id of the original operation (event or message) to which this error can be traced.

System.String applicationSubType

The sub-type of the application reporting this error. This could be used to describe a sub-system

Resource resource

The Resource associated with this error

Request request

The Request that caused this error

Fields

description

Declaration
string description
Field Value
Type Description
System.String

ErrorLevel

The Error level severity for an Error object.

Declaration
public const string ErrorLevel = null
Field Value
Type Description
System.String

InfoLevel

The Info level severity for an Error object.

Declaration
public const string InfoLevel = null
Field Value
Type Description
System.String

severity

Declaration
string severity
Field Value
Type Description
System.String

WarningLevel

The Warning level severity for an Error object.

Declaration
public const string WarningLevel = null
Field Value
Type Description
System.String

Properties

ApplicationId

Get the ID of the application that reported the error.

Declaration
public string ApplicationId { get; set; }
Property Value
Type Description
System.String

ApplicationName

Get the name of the application that reported the error.

Declaration
public string ApplicationName { get; set; }
Property Value
Type Description
System.String

ApplicationSubType

Get the sub-type of the application that reported the error. This could be used to describe a sub-system.

Declaration
public string ApplicationSubType { get; set; }
Property Value
Type Description
System.String

CorrelationId

Get the correlation ID for this error. This is the ID of the original operation (event or message) to which this error can be traced.

Declaration
public string CorrelationId { get; set; }
Property Value
Type Description
System.String

DateTime

Get the date and time that the error was reported.

Declaration
public DateTime? DateTime { get; set; }
Property Value
Type Description
System.Nullable<DateTime>

Description

Get the description for this error.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

Details

Get the detailed message for this error.

Declaration
public string Details { get; set; }
Property Value
Type Description
System.String

Id

Get the ID for this error.

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

Request

Get original request that caused the error.

Declaration
public Request Request { get; set; }
Property Value
Type Description
Request

Resource

Get the resource associated with this error.

Declaration
public Resource Resource { get; set; }
Property Value
Type Description
Resource

ResponseCode

Get the response code associated with this error.

Declaration
public int ResponseCode { get; set; }
Property Value
Type Description
System.Int32

Severity

Get the Severity for the error. This should be one of info, warning, or error.

Declaration
public string Severity { get; set; }
Property Value
Type Description
System.String

Methods

ToString()

Get the Error object as a JSON string.

Declaration
public override string ToString()
Returns
Type Description
System.String

JSON string for the error object.

In This Article
Back to top Generated by DocFX