Class BaseResponse

Inheritance
System.Object
BaseResponse
Namespace: Xrpl.Models.Subscriptions
Assembly: Xrpl.dll
Syntax
public class BaseResponse : object

Properties

| Improve this Doc View Source

ApiVersion

Declaration
public string ApiVersion { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Error

Declaration
public string Error { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Forwarded

(May be omitted) If true, this request and response have been forwarded from a Reporting Mode server to a P2P Mode server (and back) because the request requires data that is not available in Reporting Mode.
The default is false.

Declaration
public string Forwarded { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Id

(WebSocket only) ID provided in the request that prompted this response

Declaration
public Guid Id { get; set; }
Property Value
Type Description
Guid
| Improve this Doc View Source

Result

The result of the query; contents vary depending on the command.

Declaration
public object Result { get; set; }
Property Value
Type Description
System.Object
| Improve this Doc View Source

Status

(WebSocket only) The value success indicates the request was successfully received and understood by the server.
Some client libraries omit this field on success.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Type

(WebSocket only) The value response indicates a direct response to an API request.
Asynchronous notifications use a different value such as ledgerClosed or transaction.

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Warning

(May be omitted) If this field is provided, the value is the string load.
This means the client is approaching the rate limiting threshold where the server will disconnect this client.

Declaration
public string Warning { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Warnings

May be omitted) If this field is provided, it contains one or more Warnings Objects with important warnings.
For details, see API Warnings (https://xrpl.org/response-formatting.html#api-warnings)

Declaration
public List<RippleResponseWarning> Warnings { get; set; }
Property Value
Type Description
List<RippleResponseWarning>