Skip to content

SAIF.Web.API.Core API reference

This page lists all public types exposed by SAIF.Web.API.Core. Each type links to its full API reference page.

Types

Type Kind Namespace Purpose
ApiResponse\<T> Class SAIF.API.Responses Generic envelope carrying a typed results array alongside server/version metadata and an HttpStatusCode for a single API response.
ErrorResponse Class SAIF.API.Responses Serializable ([DataContract]) error payload with a code, message, ID, and URL, defaulting its message when constructed with only a code.
BuildInfo Class SAIF.Web.API.Core Static-usage utility that reads an optional build/version metadata file and returns its contents as key/value pairs.
SAIFException Class (abstract) SAIF.API.Exceptions Base type for all API exceptions in this library; carries a settable HttpStatusCode for HTTP-facing consumers.
NoMatchingDataException Class SAIF.API.Exceptions SAIFException subtype signaling that no matching data was found, with a fixed default message.
UnauthorizedAccessException Class SAIF.API.Exceptions SAIFException subtype signaling an authorization failure; shadows the BCL System.UnauthorizedAccessException short name.
InternalServerError Class SAIF.API.Exceptions SAIFException subtype signaling an unclassified server-side failure, with a fixed default message.
InvalidDataException Class SAIF.API.Exceptions SAIFException subtype carrying per-field ValidationFailure details for invalid request data.

Sources

  • src/SAIF.Web.API.Core/ApiResponse.cs
  • src/SAIF.Web.API.Core/ErrorResponse.cs
  • src/SAIF.Web.API.Core/BuildInfo.cs
  • src/SAIF.Web.API.Core/SAIFException.cs