Stack Overflow
Stack Overflow

Questions tagged [asp.net-web-api-odata]

ASP.NET 4.x Implementation of OData Services that supports both v3-v4 of the OData Protocol. DO NOT use this tag for [asp.net-core] related questions! Use this tag if your question directly relates to the ASP.NET server-side implementation of OData services, but also include the version specific tag [odata-v3] or [odata-v4]. Only include the non-specific [odata] tag if the question has broader client-side implications.

The ASP.NET Web API OData package offers support for the OData protocol in ASP.NET Web API.

OData is a standard protocol for creating and consuming data. The purpose of OData is to provide a protocol that is based on Representational State Transfer (REST) for create, read, update, and delete (CRUD) operations. OData applies web technologies such as HTTP and JavaScript Object Notation (JSON) to provide unified convention based access to information from various programs. OData provides the following benefits:

  • It lets developers interact with data by using RESTful web services.
  • It provides a simple and uniform way to share data in a discoverable manner.
  • It enables broad integration across products.
  • It enables integration by using the HTTP protocol stack.

Two key defining features of OData over traditional RESTful APIs are the URL conventions that make it possible to compose queries that request only the specific fields and navigation links from resources that are needed on the client as well as the ability to partially update resources using the PATCH HTTP verb.

  • Together these features allow individual clients to reduce the data sent across the wire without needing changes in the API or data schema to support this.

ASP.NET Web API supports both Version 3 and Version 4 of the OData protocol.
Learn more about ASP.NET Web API OData on MSDN

The code from this package to implement this protocol makes heavy use of Language Integrated Query (LINQ) expressions to support deferred execution of client requests, in a sense the ODataLib translates a specific set of URL queries into LINQ queries.

While not required, the ASP.NET implementation has extensive support for using Entity-Framework to access the data layer, reducing the code necessary to expose EF data schemas as OData resources. For this reason Posts on SO related to this tag will often include EF references and concepts.

You can also find more information on:

134 questions
1
vote
2 answers

Web Api 2 with OData v4 - Bound function returning complex object

In this simple example I am trying to get an object serialized as JSON from a Web Api 2 + OData v4 service. Controller has bound function Test which is returning an array of annon. objects. public class ProductsController : ODataController { …
Goran F
  • 103
  • 1
  • 7
1
vote
2 answers

POST complex type with ignored property to OData Action with multiple parameters

I have the following OData builder config. Which defines an Action Create with a few parameters. Note that I ignore the property Password. That's important later. var userEntitySetName = nameof(UsersController).Replace("Controller",…
Snæbjørn
  • 10,322
  • 14
  • 65
  • 124
1
vote
3 answers

ASP.NET WebAPI OData Delta object fields is null in PATCH request

I have created ASP.NET WebAPI with OData support. The Project class has a field named ProjectType with nullable integer type declaration: public class Project { public string Id { get; set; } public string Name { get; set; } …
Minh Nguyen
  • 2,106
  • 1
  • 28
  • 34
1
vote
0 answers

IPrincipal should be ClaimsPrincipal but is WindowsPrincipal

I've got a controller with 3 action methods on it, two of which are regular OData calls and a third which is a function. Using Azure AD and ADAL to secure the WebAPI. CustomAuthAttribute (IsAppAuthorizing Simply checks a web.config entry) public…
dtmnash
  • 166
  • 1
  • 7
1
vote
1 answer

Unit Test OData V4 PUT action with XUnit and MOQ

My goal is to unit test the PUT action in an OData v4 controller. I'm using MOQ for the Entity Framework 6 Context and NBuilder to build out the test data. I am able to successfully test Get and Get(Id), but am unable to run asserts when I retrieve…
Nathan Agersea
  • 496
  • 3
  • 17
1
vote
1 answer

How do I expose a table valued function as a property of an entity set within a Web Api 2 OData v4 service?

Please I need help figuring out how to expose a table valued function as a property of an entity set in a Web Api 2 OData v4 service. My simplified schema has three tables, Structures, Locations, and LocationLinks. A structure contains a graph…
Xycor
  • 63
  • 7
1
vote
1 answer

OData WebAPI, in-memory queryable and case-sensitivity

I have a problem with OData WebAPI and querying a EnumerableQuery (a list on which I called .AsQueryable(). I have a entity set, a controller with a Get method which returns the IQueryable. When I query that entity set and use this…
Mateo Velenik
  • 804
  • 1
  • 10
  • 22
1
vote
2 answers

What is the best way to design the related business entities in .NET to be used for Web API?

I am trying to design business entities in .NET like below which will be exposed via Web API/oData. Business Entity 1 : "Vehicle" with the properties as below: VehicleId string ModelId string Business Entity 2 : "Model" with the properties as…
DIP
  • 11
  • 1
1
vote
0 answers

Set OData navigation properties using Fluent Api

Given a Web Api 2.2 project using OData 4, I'm using entities from a third shared assembly and I would like to configure some entities specifically for the api. For instance: one of the shared entities SharedEntityA contains a field BinaryValue…
SamuGG
  • 479
  • 2
  • 8
  • 20
1
vote
2 answers

How does one define an (optional) navigation property (?$expand=) in code?

First the explanation and the gist, then the question. So: Let's say I have a view AccountView defined in EF (6.1.1) database first (edmx) so that the code-generated class is //This class is generated from a view by EF (edmx)... public partial class…
Veksi
  • 3,556
  • 3
  • 30
  • 69
1
vote
1 answer

Day of week Function in OData v4 Web Api

It doesn't look like there's any built in function for getting the day of week using a function based on the documentation here: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html What I want is a Web Api 2.2 OData…
Richie
  • 505
  • 4
  • 13
1
vote
2 answers

Breezejs Web api OData method not allowed

I am either getting a 400, 404, or 405 error attempting to query my Web API OData Service. My remote service name is configured to: var remoteServiceName = 'http://localhost:50056/odata/'; In my entityManagerFactory I have Odata…
girlcode
  • 3,155
  • 5
  • 27
  • 41
1
vote
1 answer

Remove data from an entity framework query based on something

My application has some privileged information, costs that certain users aren't allowed to see. The app uses WebAPI OData to pull data down into an AngularJS single page application which then hides or shows the data. Obviously this isn't ideal, any…
BenCr
  • 5,991
  • 5
  • 44
  • 68
1
vote
2 answers

asp.net odata web api $select failing for related entities

My entities public class A { public int id {get;set;} public string Name {get;set;} public List b {get;set;} } public class B { public string C {get;set;} public string D {get;set;} } My controller…
HarshJain
  • 327
  • 1
  • 4
  • 12
1
vote
1 answer

How to restrict access to some properties or classes in ASP.NET Web API OData?

I have class: public class Person { public virtual int Id { get; set; } public virtual string Name { get; set; } public virtual DateTime BirthDate { get; set; } } And I have WebAPI OData Controller: public class PeopleController :…
Alexander Vasilyev
  • 1,273
  • 2
  • 15
  • 22
1 2 3
…
8 9