Revision history [back]

The typical method for configuring control data in OData responses using Microsoft.AspNet.OData involves adding a configuration object to the OData controller method. This object typically includes properties that determine the amount of data returned, sorting, filtering, and pagination parameters. A sample code snippet is shown below:

public IHttpActionResult Get(ODataQueryOptions<Person> options)
{
    IQueryable<Person> people = db.People;

    // Apply the OData query options to the data source
    var result = options.ApplyTo(people) as IQueryable<Person>;

    // Generate the OData response with metadata
    var response = new PageResult<Person>(
        result,
        options.Top?.Value,
        options.Skip?.Value,
        people.Count());

    // Add control data to the response
    response.Count = people.Count();

    return Ok(response);
}

In this example, the options parameter is an instance of ODataQueryOptions<T> that contains the control data for the OData query. The ApplyTo method is called to apply the control data to the people data source, and the resulting data is wrapped in a PageResult<T> object that includes metadata such as the number of items in the response. Finally, the Count property of the PageResult<T> object is set to the total number of items in the people data source, which is returned to the client as control data along with the response data.