A Sandcastle Documented Class Library

# TenantController Class

The REST API for performing administration tasks on tenants.
Inheritance Hierarchy
System
Object
Microsoft.AspNetCore.Mvc
ControllerBase
Dundas.BI.WebApi.Controllers
ApiControllerBase
Dundas.BI.WebApi.Controllers
TenantController

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public class TenantController : ApiControllerBase

    Public Class TenantController
    	Inherits ApiControllerBase

    public ref class TenantController : public ApiControllerBase

    type TenantController =
        class
            inherit ApiControllerBase
        end

The TenantController type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| TenantController | Initializes a new instance of the TenantController class

Top
Methods

| Name | Description
--- | --- | ---
| CreateTenant | POST /Tenant/ Creates a tenant.
| DeleteTenant | DELETE /Tenant/{id} Deletes a tenant.
| 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. (Inherited from ApiControllerBase.)
| EnsureFormFileMultipartContent | Ensures when form files are access the content is MIME multi-part which we want. (Inherited from ApiControllerBase.)
| GetClientIdFromCookieOrProvided | Gets the client ID from cookie or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
| GetService T | Gets the requested service. (Inherited from ApiControllerBase.)
| GetSessionIdFromCookieHeaderOrProvided | Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
| GetTenantById | GET /Tenant/{id} Gets a tenant with the specified ID.
| GetTenantInfoById | GET /Tenant/Info/{id} Gets the tenant info for the tenant ID.
| LoadSession | Creates a new caller context associated with the specified session ID. The session is not validated. (Inherited from ApiControllerBase.)
| QueryNumberOfTenants | POST /Tenant/Count/ Gets the number of tenants that match the filter.
| QueryTenantInfos | POST /Tenant/QueryInfos Gets information about multiple tenants.
| QueryTenants | POST /Tenant/Query/ Gets the tenants with the given information.
| RemoveWarehouseOverride | POST /Tenant/RemoveWarehouseOverride/ Removes the warehouse override with the same scope and scope target.
| RequestFirstFormFile | Retrieves the first form file from the request. (Inherited from ApiControllerBase.)
| RequestFormFiles | Retrieves the form files from the request. (Inherited from ApiControllerBase.)
| ReturnInvalidWindowsIdentityResponse | Returns the invalid windows identity response to challenge the browser. (Inherited from ApiControllerBase.)
| SetWarehouseOverride | POST /Tenant/SetWarehouseOverride/ Adds the warehouse override if there is no existing override with the same scope and scope target, otherwise replaces it.
| UpdateTenant | PUT /Tenant/{id} Updates a tenant.

Top
See Also

#### Reference

Dundas.BI.WebApi.Controllers Namespace