A Sandcastle Documented Class Library

ApiControllerBase Class

The base class for REST API controllers.

Inheritance Hierarchy

SystemObject
  Microsoft.AspNetCore.MvcControllerBase
    Dundas.BI.WebApi.ControllersApiControllerBase
      More...

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.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.
	GetServiceT	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

SystemObject
  Microsoft.AspNetCore.MvcControllerBase
    Dundas.BI.WebApi.ControllersApiControllerBase
      Dundas.BI.WebApi.ControllersAccountController
      Dundas.BI.WebApi.ControllersAccountRegistrationController
      Dundas.BI.WebApi.ControllersAdminController
      Dundas.BI.WebApi.ControllersAnnotationController
      Dundas.BI.WebApi.ControllersApplicationConfigurationController
      Dundas.BI.WebApi.ControllersCodeLibraryController
      Dundas.BI.WebApi.ControllersCubePerspectiveController
      Dundas.BI.WebApi.ControllersCustomAttributesController
      Dundas.BI.WebApi.ControllersDataConnectorController
      Dundas.BI.WebApi.ControllersDataCubeController
      Dundas.BI.WebApi.ControllersDataInputController
      Dundas.BI.WebApi.ControllersDataProviderController
      Dundas.BI.WebApi.ControllersDataRetrievalController
      Dundas.BI.WebApi.ControllersDateMappingController
      Dundas.BI.WebApi.ControllersDeliveryController
      Dundas.BI.WebApi.ControllersEmailController
      Dundas.BI.WebApi.ControllersExportController
      Dundas.BI.WebApi.ControllersExtensionController
      Dundas.BI.WebApi.ControllersFeatureController
      Dundas.BI.WebApi.ControllersFederatedAuthenticationController
      Dundas.BI.WebApi.ControllersFileSystemEntryControllerBase
      Dundas.BI.WebApi.ControllersFormatController
      Dundas.BI.WebApi.ControllersGroupController
      Dundas.BI.WebApi.ControllersHealthController
      Dundas.BI.WebApi.ControllersHierarchyController
      Dundas.BI.WebApi.ControllersHierarchyEntityController
      Dundas.BI.WebApi.ControllersJobController
      Dundas.BI.WebApi.ControllersLicenseActivationController
      Dundas.BI.WebApi.ControllersLicenseController
      Dundas.BI.WebApi.ControllersLocalizationController
      Dundas.BI.WebApi.ControllersLoggingController
      Dundas.BI.WebApi.ControllersLogOnController
      Dundas.BI.WebApi.ControllersMachineLearningController
      Dundas.BI.WebApi.ControllersMapController
      Dundas.BI.WebApi.ControllersMetricSetController
      Dundas.BI.WebApi.ControllersNativeStructureController
      Dundas.BI.WebApi.ControllersNotificationController
      Dundas.BI.WebApi.ControllersParameterController
      Dundas.BI.WebApi.ControllersPrivilegeController
      Dundas.BI.WebApi.ControllersRelationshipController
      Dundas.BI.WebApi.ControllersResourceController
      Dundas.BI.WebApi.ControllersServerController
      Dundas.BI.WebApi.ControllersServerGroupController
      Dundas.BI.WebApi.ControllersSessionController
      Dundas.BI.WebApi.ControllersShortLinkController
      Dundas.BI.WebApi.ControllersSlideshowController
      Dundas.BI.WebApi.ControllersStyleController
      Dundas.BI.WebApi.ControllersTenantController
      Dundas.BI.WebApi.ControllersThemeController
      Dundas.BI.WebApi.ControllersTimeDimensionController
      Dundas.BI.WebApi.ControllersTimeDimensionProviderController
      Dundas.BI.WebApi.ControllersTokenController
      Dundas.BI.WebApi.ControllersTransferController
      Dundas.BI.WebApi.ControllersViewControllerT