ODataHttpRouteCollectionExtensions.MapODataRoute Method

Namespace:   System.Web.Http
Assembly:  System.Web.Http.OData (in System.Web.Http.OData.dll)

Overload List

	Name	Description
	MapODataRoute(HttpRouteCollection, String, String, IEdmModel)	Obsolete.Maps the specified OData route.
	MapODataRoute(HttpRouteCollection, String, String, IEdmModel, IODataPathHandler, IEnumerable<IODataRoutingConvention>)	Obsolete.Maps the specified OData route.
	MapODataRoute(HttpRouteCollection, String, String, IEdmModel, IODataPathHandler, IEnumerable<IODataRoutingConvention>, ODataBatchHandler)	Obsolete.Maps the specified OData route. When the batchHandler is provided, it will create a '$batch' endpoint to handle the batch requests.
	MapODataRoute(HttpRouteCollection, String, String, IEdmModel, ODataBatchHandler)	Obsolete.Maps the specified OData route. When the batchHandler is provided, it will create a '$batch' endpoint to handle the batch requests.

See Also

ODataHttpRouteCollectionExtensions Class
System.Web.Http Namespace

Return to top

ODataHttpRouteCollectionExtensions.MapODataRoute Method (HttpRouteCollection, String, String, IEdmModel)

Note: This API is now obsolete.

Maps the specified OData route.

Syntax

[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
public static void MapODataRoute(
    this HttpRouteCollection routes,
    string routeName,
    string routePrefix,
    IEdmModel model
)

public:
[ExtensionAttribute]
[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
static void MapODataRoute(
    HttpRouteCollection^ routes,
    String^ routeName,
    String^ routePrefix,
    IEdmModel^ model
)

[<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>]
static member MapODataRoute : 
        routes:HttpRouteCollection *
        routeName:string *
        routePrefix:string *
        model:IEdmModel -> unit

<ExtensionAttribute>
<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>
Public Shared Sub MapODataRoute (
    routes As HttpRouteCollection,
    routeName As String,
    routePrefix As String,
    model As IEdmModel
)

Parameters

• routes
  Type: System.Web.Http.HttpRouteCollection

  A collection of routes for the application.

• routeName
  Type: System.String

  The name of the route to map.

• routePrefix
  Type: System.String

  The prefix to add to the OData route's path template.

• model
  Type: Microsoft.Data.Edm.IEdmModel

  The EDM model to use for parsing OData paths.

Return to top

ODataHttpRouteCollectionExtensions.MapODataRoute Method (HttpRouteCollection, String, String, IEdmModel, IODataPathHandler, IEnumerable<IODataRoutingConvention>)

Note: This API is now obsolete.

Maps the specified OData route.

Syntax

[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
public static void MapODataRoute(
    this HttpRouteCollection routes,
    string routeName,
    string routePrefix,
    IEdmModel model,
    IODataPathHandler pathHandler,
    IEnumerable<IODataRoutingConvention> routingConventions
)

public:
[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
[ExtensionAttribute]
static void MapODataRoute(
    HttpRouteCollection^ routes,
    String^ routeName,
    String^ routePrefix,
    IEdmModel^ model,
    IODataPathHandler^ pathHandler,
    IEnumerable<IODataRoutingConvention^>^ routingConventions
)

[<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>]
static member MapODataRoute : 
        routes:HttpRouteCollection *
        routeName:string *
        routePrefix:string *
        model:IEdmModel *
        pathHandler:IODataPathHandler *
        routingConventions:IEnumerable<IODataRoutingConvention> -> unit

<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>
<ExtensionAttribute>
Public Shared Sub MapODataRoute (
    routes As HttpRouteCollection,
    routeName As String,
    routePrefix As String,
    model As IEdmModel,
    pathHandler As IODataPathHandler,
    routingConventions As IEnumerable(Of IODataRoutingConvention)
)

Parameters

• routes
  Type: System.Web.Http.HttpRouteCollection

  A collection of routes for the application.

• routeName
  Type: System.String

  The name of the route to map.

• routePrefix
  Type: System.String

  The prefix to add to the OData route's path template.

• model
  Type: Microsoft.Data.Edm.IEdmModel

  The EDM model to use for parsing OData paths.

• pathHandler
  Type: System.Web.Http.OData.Routing.IODataPathHandler

  The IODataPathHandler to use for parsing the OData path.

• routingConventions
  Type: System.Collections.Generic.IEnumerable<IODataRoutingConvention>

  The OData routing conventions to use for controller and action selection.

Return to top

ODataHttpRouteCollectionExtensions.MapODataRoute Method (HttpRouteCollection, String, String, IEdmModel, IODataPathHandler, IEnumerable<IODataRoutingConvention>, ODataBatchHandler)

Note: This API is now obsolete.

Maps the specified OData route. When the batchHandler is provided, it will create a '$batch' endpoint to handle the batch requests.

Syntax

[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
public static void MapODataRoute(
    this HttpRouteCollection routes,
    string routeName,
    string routePrefix,
    IEdmModel model,
    IODataPathHandler pathHandler,
    IEnumerable<IODataRoutingConvention> routingConventions,
    ODataBatchHandler batchHandler
)

public:
[ExtensionAttribute]
[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
static void MapODataRoute(
    HttpRouteCollection^ routes,
    String^ routeName,
    String^ routePrefix,
    IEdmModel^ model,
    IODataPathHandler^ pathHandler,
    IEnumerable<IODataRoutingConvention^>^ routingConventions,
    ODataBatchHandler^ batchHandler
)

[<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>]
static member MapODataRoute : 
        routes:HttpRouteCollection *
        routeName:string *
        routePrefix:string *
        model:IEdmModel *
        pathHandler:IODataPathHandler *
        routingConventions:IEnumerable<IODataRoutingConvention> *
        batchHandler:ODataBatchHandler -> unit

<ExtensionAttribute>
<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>
Public Shared Sub MapODataRoute (
    routes As HttpRouteCollection,
    routeName As String,
    routePrefix As String,
    model As IEdmModel,
    pathHandler As IODataPathHandler,
    routingConventions As IEnumerable(Of IODataRoutingConvention),
    batchHandler As ODataBatchHandler
)

Parameters

• routes
  Type: System.Web.Http.HttpRouteCollection

  A collection of routes for the application.

• routeName
  Type: System.String

  The name of the route to map.

• routePrefix
  Type: System.String

  The prefix to add to the OData route's path template.

• model
  Type: Microsoft.Data.Edm.IEdmModel

  The EDM model to use for parsing OData paths.

• pathHandler
  Type: System.Web.Http.OData.Routing.IODataPathHandler

  The IODataPathHandler to use for parsing the OData path.

• routingConventions
  Type: System.Collections.Generic.IEnumerable<IODataRoutingConvention>

  The OData routing conventions to use for controller and action selection.

• batchHandler
  Type: System.Web.Http.OData.Batch.ODataBatchHandler

  The ODataBatchHandler.

Return to top

ODataHttpRouteCollectionExtensions.MapODataRoute Method (HttpRouteCollection, String, String, IEdmModel, ODataBatchHandler)

Note: This API is now obsolete.

Maps the specified OData route. When the batchHandler is provided, it will create a '$batch' endpoint to handle the batch requests.

Syntax

[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
public static void MapODataRoute(
    this HttpRouteCollection routes,
    string routeName,
    string routePrefix,
    IEdmModel model,
    ODataBatchHandler batchHandler
)

public:
[ExtensionAttribute]
[ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")]
static void MapODataRoute(
    HttpRouteCollection^ routes,
    String^ routeName,
    String^ routePrefix,
    IEdmModel^ model,
    ODataBatchHandler^ batchHandler
)

[<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>]
static member MapODataRoute : 
        routes:HttpRouteCollection *
        routeName:string *
        routePrefix:string *
        model:IEdmModel *
        batchHandler:ODataBatchHandler -> unit

<ExtensionAttribute>
<ObsoleteAttribute("This method is obsolete; use the MapODataServiceRoute method from the System.Web.Http.OData.Extensions or System.Web.OData.Extensions namespace.")>
Public Shared Sub MapODataRoute (
    routes As HttpRouteCollection,
    routeName As String,
    routePrefix As String,
    model As IEdmModel,
    batchHandler As ODataBatchHandler
)

Parameters

• routes
  Type: System.Web.Http.HttpRouteCollection

  A collection of routes for the application.

• routeName
  Type: System.String

  The name of the route to map.

• routePrefix
  Type: System.String

  The prefix to add to the OData route's path template.

• model
  Type: Microsoft.Data.Edm.IEdmModel

  The EDM model to use for parsing OData paths.

• batchHandler
  Type: System.Web.Http.OData.Batch.ODataBatchHandler

  The ODataBatchHandler.

Return to top