Class BluestoneException

A non-success PAPI response, including HTTP 429 Too Many Requests. Activout.Blue5 never retries; add Activout.Blue5.Resilience (or your own policy) for that.

Inheritance

object

Exception

BluestoneException

Implements

ISerializable

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.ReferenceEquals(object, object)

Namespace: Activout.Blue5

Assembly: Activout.Blue5.dll

Syntax

public sealed class BluestoneException : Exception, ISerializable

Constructors

BluestoneException(HttpStatusCode, string, string?, string?, IReadOnlyList<string>?, string?)

Creates the exception.

Declaration

public BluestoneException(HttpStatusCode statusCode, string message, string? papiMessage = null, string? entityId = null, IReadOnlyList<string>? entityIds = null, string? requestId = null)

Parameters

Type	Name	Description
HttpStatusCode	statusCode
string	message
string	papiMessage
string	entityId
IReadOnlyList<string>	entityIds
string	requestId

Properties

EntityId

The entityId from the PAPI error body, e.g. the missing product id or unknown context.

Declaration

public string? EntityId { get; }

Property Value

Type	Description
string

EntityIds

The entityIds from the PAPI error body; empty when not supplied.

Declaration

public IReadOnlyList<string> EntityIds { get; }

Property Value

Type	Description
IReadOnlyList<string>

IsRateLimited

true for HTTP 429 Too Many Requests.

Declaration

public bool IsRateLimited { get; }

Property Value

Type	Description
bool

PapiMessage

The message from the PAPI error body, if any.

Declaration

public string? PapiMessage { get; }

Property Value

Type	Description
string

RequestId

The x-request-tracker response header, useful when contacting Bluestone support.

Declaration

public string? RequestId { get; }

Property Value

Type	Description
string

StatusCode

HTTP status returned by PAPI.

Declaration

public HttpStatusCode StatusCode { get; }

Property Value

Type	Description
HttpStatusCode

Implements

ISerializable