Class
ReportsControllerConfiguration

Provides static methods for registering Telerik Reporting Web API routes in ASP.NET Web API applications.

Definition

Namespace:Telerik.Reporting.Services.WebApi

Assembly:Telerik.Reporting.Services.WebApi.dll

Syntax:

cs-api-definition
public class ReportsControllerConfiguration

Inheritance: objectReportsControllerConfiguration

Constructors

ReportsControllerConfiguration()

Declaration

cs-api-definition
public ReportsControllerConfiguration()

Methods

RegisterRoutes(HttpConfiguration)

Registers all necessary Telerik Reporting Web API routes using the default "api" path prefix.

Declaration

cs-api-definition
public static void RegisterRoutes(HttpConfiguration config)

Parameters

config

HttpConfiguration

The HTTP configuration object to register the routes with.

Remarks

This method registers routes with the standard "api/{controller}" pattern commonly used in Web API applications. All Telerik Reporting service endpoints will be accessible under the "/api/reports" path by default. Call this method during application startup, typically in the WebApiConfig.Register method.

RegisterRoutes(HttpConfiguration, string)

Registers all necessary Telerik Reporting Web API routes with a custom path prefix to avoid routing conflicts.

Declaration

cs-api-definition
public static void RegisterRoutes(HttpConfiguration config, string firstPathSegment)

Parameters

config

HttpConfiguration

The HTTP configuration object to register the routes with.

firstPathSegment

string

The custom path segment to use as the first part of all route templates. For example, "reportingapi" would create routes like "/reportingapi/reports/clients".

Remarks

Use this overload when you need to avoid routing conflicts with other Web API services in your application. When using a custom path segment, ensure that your client-side report viewer is configured to use the corresponding service URL. For example, if you use "reportingapi" as the path segment, configure the report viewer's serviceUrl to "/reportingapi/reportviewer". This method registers all endpoints needed for report viewing, document generation, client session management, and AI integration.