Overview of Open Data Protocol (ODP)

The Open Data Protocol (OData) is a protocol to request data through a query string.

The Open Data Protocol (OData) is a protocol to access data on the web. It provides a uniform way to query and manipulate data sets through CRUD operations.

This article shows how to create an OData v4 endpoint that supports Get operations.

This article has two sections:

Creating OData serviceGet methods.
Consuming OData service Get methods using AngularJS.

Why we need an OData Service?

Advantages

OData is based on RESTful architecture, so we can retrieve data based on an URL query string.
OData supports HTTP, Atom Pub as well as JSON format.
It is very lightweight to use. Since it is lightweight, the performance is very good while interacting between client and service.
It supports for any type of data source. Even you can use your own custom class as a data source.
You can create your own custom methods and expose it.
It supports different HTTP methods:
1. GET: Gets one or many entries.
2. POST: Create a new entry.
3. PUT: Update an existing entry.
4. DELETE: Remove an entry.

Limitations

It is much less secure as it is purely URL based.
As per my understanding, OData does not support every query operator in LINQ like Filter, Skip, Take etc.

Create the Visual Studio Project

In Visual Studio, from the File menu, select New > Project.

Expand Installed > Templates > Visual C# > Web, and select the ASP.NET Web Application template. Name the project "ODataServiceApp".

Web Application template

In the New Project dialog, select the Empty template. Click Web APIcheckbox. Click OK.

Install the OData Packages

From the Tools menu, select NuGet Package Manager > Package Manager Console. Run the following command in the Package Manager Console.

PM> Install-Package Microsoft.AspNet.OData

This command installs the latest OData NuGet packages.

Note: You can install OData either from Package Manager Console or Package Manager Console for Solution.

Add Model Classes

A model is a class that contains data entity in the application.

In Solution Explorer, Right-click the Model folder. From the context menu, select Add > Class.

Model

Add two model class Course.cs and Subject.cs under Model folder.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
namespace ODataServiceApp.Models
{
publicclassCourse
{
[Key]
publicString ID
{
get;
set;
}
[Required]
publicString Name
{
get;
set;
}
publicString Description
{
get;
set;
}
publicList < Subject > Subjects
{
get;
set;
}
}
}

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Web;
namespace ODataServiceApp.Models
{
publicclassSubject
{
[Key]
publicString ID
{
get;
set;
}
[Required]
publicString Name
{
get;
set;
}
}
}

The attributes [Key] and [Required] are all from. System.ComponentModel.DataAnnotations.

Inline data source

This example uses inline data sources. The below steps describe how to to create the inline data source.

Add a folder DataSource and add a class with name SampleDataSources.cs with the code below:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using ODataServiceApp.Models;
namespace ODataServiceApp.DataSource
{
publicclassDemoDataSources
{
privatestaticDemoDataSources instance
= null;
publicstaticDemoDataSources Instance
{
get
{
if (instance == null)
{
instance = newDemoDataSources();
}
return instance;
}
}
publicList < Course > Courses
{
get;
set;
}
publicList < Subject > Subjects
{
get;
set;
}
private DemoDataSources()
{
this.Reset();
this.Initialize();
}
publicvoid Reset()
{
this.Courses = newList < Course >
();
this.Subjects = newList < Subject >
();
}
publicvoid Initialize()
{
this.Subjects.AddRange(newList <
Subject > ()
{
newSubject()
{
ID = "0",
Name = "C"
},
newSubject()
{
ID = "1",
Name = "C++"
},
newSubject()
{
ID = "2",
Name = "Data Structure"
},
newSubject()
{
ID = "3",
Name = ".Net"
}
});
this.Courses.AddRange(newList <
Course >
{
newCourse()
{
ID = "001",
Name = "MCA",
Subjects = newList < Subject >
{
Subjects[0],
Subjects[1]
},
Description =
"Master of Computer Application"
},
newCourse()
{
ID = "002",
Name = "MBA",
Description =
"Master of Business Application",
Subjects = newList < Subject >
{
Subjects[2],
Subjects[3]
}
},
newCourse()
{
ID = "003",
Name = "CA",
Description =
"Chartered Accountant",
},
newCourse()
{
ID = "004",
Name = "MA"
}
});
}
}
}

Add Controllers

Add two controller classes under the folder Controllers

First is controller for Courses,

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using ODataServiceApp.DataSource;
using System.Web.Http;
using System.Web.OData;
namespace ODataServiceApp.Controllers
{
[EnableQuery]
publicclassCourseController:
ODataController
{
publicIHttpActionResult Get()
{
return Ok(DemoDataSources.Instance
.Courses.AsQueryable());
}
}
}

2nd controller for Subjects,

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using ODataServiceApp.DataSource;
using System.Web.Http;
using System.Web.OData;
namespace ODataServiceApp.Controllers
{
[EnableQuery]
publicclassSubjectsController:
ODataController
{
publicIHttpActionResult Get()
{
return Ok(DemoDataSources.Instance
.Subjects.AsQueryable());
}
}
}

Configure the Endpoint

Modify the WebApiConfig.cs file under App_Startto configure the Endpoints.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
using ODataServiceApp.Models;
using Microsoft.OData.Edm;
using System.Web.OData.Batch;
using System.Web.OData.Builder;
using System.Web.OData.Extensions;
namespace ODataServiceApp
{
publicstaticclassWebApiConfig
{
publicstaticvoid Register(
HttpConfiguration config)
{
config.MapODataServiceRoute("odata",
null, GetEdmModel(),
newDefaultODataBatchHandler(
GlobalConfiguration.DefaultServer
));
config.EnsureInitialized();
}
privatestaticIEdmModel GetEdmModel()
{
ODataConventionModelBuilder builder
= newODataConventionModelBuilder();
builder.Namespace =
"ODataServiceApp";
builder.ContainerName =
"DefaultContainer";
builder.EntitySet < Course > (
"Courses");
builder.EntitySet < Subject > (
"Subjects");
var edmModel = builder.GetEdmModel();
return edmModel;
}
}
}

Below URLs to call GET methods.

Service document

http://localhost:[portNumber]/
Service metadata

http://localhost:[portNumber]/$metadata
Get Courses

http://localhost:[portNumber]/Courses
Get Subjects

http://localhost:[portNumber]/Subjects
Queries

http://localhost:[portNumber]/Courses?$filter=contains(Description,'Computer')
http://localhost:[portNumber]/Courses?$select=Name
http://localhost:[portNumber]/Courses?$expand=Subjects
http://localhost:[portNumber]/Subjects?$filter=contains(Name,'Structure')http://localhost:[portNumber]/Subjects?$select=Name

OData service creation is completed and now it’s time to consume it. It can be consumed in different ways; either using web application or web site etc. Scripting languages or frameworks can be used to consume the OData services. In the below example, websiteandAngularJS framework are used to consume OData service.

Consuming OData service Get methods

Steps to consume OData service Get methods

In Visual Studio, from the File menu, select New > Web Site.

Expand Installed > Templates > Visual C# > Web, and select the ASP.NET Empty Web Site template. Name the project "ODataWebAppClient".

ASP.NET Empty Web

In Solution Explorer, Right-click and select Add > HTML Page and name it as “Index.html”.

Index.htmlwith the code below:

<!DOCTYPEhtml>
<html>
<head>
<title></title>
<metacharset="utf-8" />
<linkrel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
<scriptsrc="//code.jquery.com/jquery-2.1.3.min.js">
</script>
<scriptsrc="//ajax.googleapis.com/ajax/libs/angularjs/1.3.11/angular.min.js">
</script>
<scriptsrc="//cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.12.0/ui-bootstrap.min.js">
</script>
<scripttype="text/javascript">
'use strict'; var app = angular.module('OData',
[]); app.controller("ODataController",
['$scope', '$http', function ($scope,
$http) { $scope.SubjectList = []; $scope.GetSubjectList
= function () { $http({ method: 'GET',
url: "http://localhost:52766/Subjects?$filter=contains(Name,'Structure')",
async: true, cache: true, headers:
{ 'Content-Type': "application/json;
charset=utf-8" } }) .success(function
(data) { $scope.SubjectList = data.value;
}) .error(function (data, status, headers,
config) { alert(data.error.trim());
}) }; $scope.GetSubjectList(); }]);
</script>
</head>
<bodyng-app="OData" class="container">
<divng-controller="ODataController" ng-class="row">
<tableclass="table table-striped">
<thead>
<tr>
<th>ID</th>
<th>Name</th>
</tr>
</thead>
<tbody>
<trng-repeat="iteminSubjectList">
<td>{{item.ID}}</td>
<td>{{item.Name}}</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>

Below CSS and scripts from CDN are used for the above example:

<linkrel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
<scriptsrc="//code.jquery.com/jquery-2.1.3.min.js">
</script>
<scriptsrc="//ajax.googleapis.com/ajax/libs/angularjs/1.3.11/angular.min.js">
</script>
<scriptsrc="//cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.12.0/ui-bootstrap.min.js">
</script>

Output:

Output

16 Comments

Join the conversation! Your thoughts help the community grow.

Santosh Kumar Adidawarpu10y ago
Thanks everyone
Sr Karthiga10y ago
good one
Mithun Pradhan10y ago
This article is very helpful...
Vivek Kumar10y ago
Nice article santosh
siva rayi10y ago
Good one Santosh. Keep it up!
Sonu Chaudhary10y ago
Good one
Nitesh Jha10y ago
Good explanation Santosh
Kishan Theratipally10y ago
Nice santhosh
Satya Reddy10y ago
Thanks for sharing and keep continue...
Amit Kumar Singh10y ago
Nice
Ranjeet Patra10y ago
Nice article to start with ODP
Always FRIEND10y ago
Nice article to learn and good explanation
Gowtham Rajamanickam10y ago
Good one..
Ammar Shaukat10y ago
Nice share.
Raja T10y ago
Nice, Thanks for sharing
Vignesh Mani10y ago
NIce