ApiException

public class ApiException : TypeSafeException, ISerializable

An unsuccessful HTTP response from the API. Mirrors JS APIError.

Inheritance: object → Exception → TypeSafeException

Implements: ISerializable

Derived: AuthenticationException, BadRequestException, InternalServerException, NotFoundException, PermissionDeniedException, RateLimitException, UnprocessableEntityException

Constructors

public ApiException(HttpStatusCode statusCode, object? body, HttpResponseHeaders headers, string? message = null)

Create an API error from a completed HTTP response.

Parameters

public object? Body { get; }

Parsed JSON, response text, or null for an empty body.

Value: object

public HttpResponseHeaders Headers { get; }

HTTP response headers.

Value: HttpResponseHeaders

public string? RequestId { get; }

Request ID from x-typesafe-request-id, or null when absent.

Value: string

public int Status { get; }

Numeric HTTP status.

Value: int

public HttpStatusCode StatusCode { get; }

HTTP response status code.

Value: HttpStatusCode

public static ApiException FromResponse(HttpStatusCode statusCode, object? body, HttpResponseHeaders headers)

Create the error subclass for an HTTP status code.

Parameters

Returns: ApiException

MIT · Copyright (c) Dario Kondratiuk. · not affiliated with TypeSafe beyond being a client of the public API