Open this page in the API Guide

A Sandcastle Documented Class Library

ApiControllerBase Class

The base class for REST API controllers.

Inheritance Hierarchy

System.Object
  Microsoft.AspNetCore.Mvc.ControllerBase
    Dundas.BI.WebApi.Controllers.ApiControllerBase
      More...

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.1.0.1000)

Syntax

[ControllerAttribute]
[AreaAttribute("api")]
[RouteAttribute("api/[controller]")]
[ProducesResponseTypeAttribute(200)]
[ProducesResponseTypeAttribute(400)]
public abstract class ApiControllerBase : ControllerBase

<ControllerAttribute>
<AreaAttribute("api")>
<RouteAttribute("api/[controller]")>
<ProducesResponseTypeAttribute(200)>
<ProducesResponseTypeAttribute(400)>
Public MustInherit Class ApiControllerBase
	Inherits ControllerBase

[ControllerAttribute]
[AreaAttribute(L"api")]
[RouteAttribute(L"api/[controller]")]
[ProducesResponseTypeAttribute(200)]
[ProducesResponseTypeAttribute(400)]
public ref class ApiControllerBase abstract : public ControllerBase

[<AbstractClassAttribute>]
[<ControllerAttribute>]
[<AreaAttribute("api")>]
[<RouteAttribute("api/[controller]")>]
[<ProducesResponseTypeAttribute(200)>]
[<ProducesResponseTypeAttribute(400)>]
type ApiControllerBase =  
    class
        inherit ControllerBase
    end

The ApiControllerBase type exposes the following members.

Methods

	Name	Description
	EnsureCallerContext	If the current context is not already the specified context, creates a new caller context which is a clone of the specified context and sets it as the current one.
	EnsureFormFileMultipartContent	Ensures when form files are access the content is MIME multi-part which we want.
	GetClientIdFromCookieOrProvided	Gets the client ID from cookie or from the provided value, which is usually from the query string.
	GetService<T>	Gets the requested service.
	GetSessionIdFromCookieHeaderOrProvided	Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string.
	LoadSession	Creates a new caller context associated with the specified session ID. The session is not validated.
	RequestFirstFormFile	Retrieves the first form file from the request.
	RequestFormFiles	Retrieves the form files from the request.
	ReturnInvalidWindowsIdentityResponse	Returns the invalid windows identity response to challenge the browser.

See Also

Reference

Dundas.BI.WebApi.Controllers Namespace

Inheritance Hierarchy

System.Object
  Microsoft.AspNetCore.Mvc.ControllerBase
    Dundas.BI.WebApi.Controllers.ApiControllerBase
      Dundas.BI.WebApi.Controllers.AccountController
      Dundas.BI.WebApi.Controllers.AccountRegistrationController
      Dundas.BI.WebApi.Controllers.AdminController
      Dundas.BI.WebApi.Controllers.AnnotationController
      Dundas.BI.WebApi.Controllers.ApplicationConfigurationController
      Dundas.BI.WebApi.Controllers.CodeLibraryController
      Dundas.BI.WebApi.Controllers.CubePerspectiveController
      Dundas.BI.WebApi.Controllers.CustomAttributesController
      Dundas.BI.WebApi.Controllers.DataConnectorController
      Dundas.BI.WebApi.Controllers.DataCubeController
      Dundas.BI.WebApi.Controllers.DataInputController
      Dundas.BI.WebApi.Controllers.DataProviderController
      Dundas.BI.WebApi.Controllers.DataRetrievalController
      Dundas.BI.WebApi.Controllers.DateMappingController
      Dundas.BI.WebApi.Controllers.DeliveryController
      Dundas.BI.WebApi.Controllers.EmailController
      Dundas.BI.WebApi.Controllers.ExportController
      Dundas.BI.WebApi.Controllers.ExtensionController
      Dundas.BI.WebApi.Controllers.FeatureController
      Dundas.BI.WebApi.Controllers.FederatedAuthenticationController
      Dundas.BI.WebApi.Controllers.FileSystemEntryControllerBase
      Dundas.BI.WebApi.Controllers.FormatController
      Dundas.BI.WebApi.Controllers.GroupController
      Dundas.BI.WebApi.Controllers.HealthController
      Dundas.BI.WebApi.Controllers.HierarchyController
      Dundas.BI.WebApi.Controllers.HierarchyEntityController
      Dundas.BI.WebApi.Controllers.JobController
      Dundas.BI.WebApi.Controllers.LicenseActivationController
      Dundas.BI.WebApi.Controllers.LicenseController
      Dundas.BI.WebApi.Controllers.LocalizationController
      Dundas.BI.WebApi.Controllers.LoggingController
      Dundas.BI.WebApi.Controllers.LogOnController
      Dundas.BI.WebApi.Controllers.MachineLearningController
      Dundas.BI.WebApi.Controllers.MapController
      Dundas.BI.WebApi.Controllers.MetricSetController
      Dundas.BI.WebApi.Controllers.NativeStructureController
      Dundas.BI.WebApi.Controllers.NotificationController
      Dundas.BI.WebApi.Controllers.ParameterController
      Dundas.BI.WebApi.Controllers.PrivilegeController
      Dundas.BI.WebApi.Controllers.RelationshipController
      Dundas.BI.WebApi.Controllers.ResourceController
      Dundas.BI.WebApi.Controllers.ServerController
      Dundas.BI.WebApi.Controllers.ServerGroupController
      Dundas.BI.WebApi.Controllers.SessionController
      Dundas.BI.WebApi.Controllers.ShortLinkController
      Dundas.BI.WebApi.Controllers.SlideshowController
      Dundas.BI.WebApi.Controllers.StyleController
      Dundas.BI.WebApi.Controllers.TenantController
      Dundas.BI.WebApi.Controllers.ThemeController
      Dundas.BI.WebApi.Controllers.TimeDimensionController
      Dundas.BI.WebApi.Controllers.TimeDimensionProviderController
      Dundas.BI.WebApi.Controllers.TokenController
      Dundas.BI.WebApi.Controllers.TransferController
      Dundas.BI.WebApi.Controllers.ViewController<T>