Class ApiBaseController

Namespace

InSite.Api.Settings

Assembly

InSite.UI.dll

public abstract class ApiBaseController : ApiController, IHttpController, IDisposable

Inheritance

object

ApiController

ApiBaseController

Implements

IHttpController

IDisposable

Derived

AchievementDocumentsController

AchievementTemplatesController

AssessmentsController

AssetsController

ChangesController

ClientController

CmdsContactsController

CmdsDocumentsController

CmdsReportsController

CmdsTemplatesController

ContentsController

EventsController

FilesController

FilesLegacyController

FormsController

HealthController

LearnersController

OpenBadgesController

ProductsController

ProgramsController

ReactController

RegistrationsController

SessionsController

SitesController

StandardsController

TimelinesController

ApiOpenController

MaintenanceController

Inherited Members

ApiController.ExecuteAsync(HttpControllerContext, CancellationToken)

ApiController.Validate<TEntity>(TEntity)

ApiController.Validate<TEntity>(TEntity, string)

ApiController.BadRequest()

ApiController.BadRequest(string)

ApiController.BadRequest(ModelStateDictionary)

ApiController.Conflict()

ApiController.Content<T>(HttpStatusCode, T)

ApiController.Content<T>(HttpStatusCode, T, MediaTypeFormatter)

ApiController.Content<T>(HttpStatusCode, T, MediaTypeFormatter, string)

ApiController.Content<T>(HttpStatusCode, T, MediaTypeFormatter, MediaTypeHeaderValue)

ApiController.Created<T>(string, T)

ApiController.Created<T>(Uri, T)

ApiController.CreatedAtRoute<T>(string, object, T)

ApiController.CreatedAtRoute<T>(string, IDictionary<string, object>, T)

ApiController.InternalServerError()

ApiController.InternalServerError(Exception)

ApiController.Json<T>(T)

ApiController.Json<T>(T, JsonSerializerSettings)

ApiController.Json<T>(T, JsonSerializerSettings, Encoding)

ApiController.NotFound()

ApiController.Ok()

ApiController.Ok<T>(T)

ApiController.Redirect(string)

ApiController.Redirect(Uri)

ApiController.RedirectToRoute(string, object)

ApiController.RedirectToRoute(string, IDictionary<string, object>)

ApiController.ResponseMessage(HttpResponseMessage)

ApiController.StatusCode(HttpStatusCode)

ApiController.Unauthorized(params AuthenticationHeaderValue[])

ApiController.Unauthorized(IEnumerable<AuthenticationHeaderValue>)

ApiController.Initialize(HttpControllerContext)

ApiController.Dispose()

ApiController.Dispose(bool)

ApiController.Configuration

ApiController.ControllerContext

ApiController.ActionContext

ApiController.ModelState

ApiController.Request

ApiController.RequestContext

ApiController.Url

ApiController.User

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ApiBaseController()

protected ApiBaseController()

Properties

CurrentOrganization

protected static OrganizationState CurrentOrganization { get; }

Property Value

OrganizationState

CurrentUser

protected static User CurrentUser { get; }

Property Value

User

IsAdministrator

protected static bool IsAdministrator { get; }

Property Value

bool

Methods

DefaultJsonError(HttpRequestMessage, object, HttpStatusCode)

public static HttpResponseMessage DefaultJsonError(HttpRequestMessage request, object data, HttpStatusCode status = HttpStatusCode.InternalServerError)

Parameters

request HttpRequestMessage

data object

status HttpStatusCode

Returns

HttpResponseMessage

DefaultJsonSuccess(HttpRequestMessage, object, HttpStatusCode)

public static HttpResponseMessage DefaultJsonSuccess(HttpRequestMessage request, object data, HttpStatusCode status = HttpStatusCode.OK)

Parameters

request HttpRequestMessage

data object

status HttpStatusCode

Returns

HttpResponseMessage

DefaultRedirect(HttpRequestMessage, string, HttpStatusCode)

public static HttpResponseMessage DefaultRedirect(HttpRequestMessage request, string redirectUrl, HttpStatusCode status = HttpStatusCode.Found)

Parameters

request HttpRequestMessage

redirectUrl string

status HttpStatusCode

Returns

HttpResponseMessage

DefaultStringSuccess(HttpRequestMessage, string, HttpStatusCode)

public static HttpResponseMessage DefaultStringSuccess(HttpRequestMessage request, string data, HttpStatusCode status = HttpStatusCode.OK)

Parameters

request HttpRequestMessage

data string

status HttpStatusCode

Returns

HttpResponseMessage

GetOrganization()

protected OrganizationState GetOrganization()

Returns

OrganizationState

JsonBadRequest(object)

protected HttpResponseMessage JsonBadRequest(object data)

Parameters

data object

Returns

HttpResponseMessage

JsonError(object, HttpStatusCode)

protected HttpResponseMessage JsonError(object data, HttpStatusCode status = HttpStatusCode.InternalServerError)

Parameters

data object

status HttpStatusCode

Returns

HttpResponseMessage

JsonSuccess(object, HttpStatusCode)

protected HttpResponseMessage JsonSuccess(object data, HttpStatusCode status = HttpStatusCode.OK)

Parameters

data object

status HttpStatusCode

Returns

HttpResponseMessage

JsonUnauthorized(object, HttpStatusCode)

protected HttpResponseMessage JsonUnauthorized(object data, HttpStatusCode status = HttpStatusCode.Unauthorized)

Parameters

data object

status HttpStatusCode

Returns

HttpResponseMessage

Redirect(string, HttpStatusCode)

protected HttpResponseMessage Redirect(string redirectUrl, HttpStatusCode status = HttpStatusCode.Found)

Parameters

redirectUrl string

status HttpStatusCode

Returns

HttpResponseMessage

SendCommand(ICommand)

protected static void SendCommand(ICommand command)

Parameters

command ICommand

SetupCommandIdentity<TCommand>(TCommand)

protected static TCommand SetupCommandIdentity<TCommand>(TCommand command) where TCommand : ICommand

Parameters

command TCommand

Returns

TCommand

Type Parameters

TCommand

StringSuccess(string, HttpStatusCode)

protected HttpResponseMessage StringSuccess(string data, HttpStatusCode status = HttpStatusCode.OK)

Parameters

data string

status HttpStatusCode

Returns

HttpResponseMessage