UriJsonSource Class

Associates a JsonDataSource object with JSON data retrieved from a web service endpoint or a text file.

Namespace: DevExpress.DataAccess.Json

Assembly: DevExpress.DataAccess.v19.2.dll

Declaration

C#

public class UriJsonSource :
    JsonSourceBase

VB.NET

Public Class UriJsonSource
    Inherits JsonSourceBase

Remarks

You can add path parameters, query parameters, or header parameters to the UriJsonSource to customize requests to a JSON web service endpoint.

• A path parameter adds a path element to a JSON endpoint’s Uri.
• A query parameter specifies an HTTP request parameter that is passed to a JSON endpoint.
• A header parameter adds a custom HTTP header to JSON endpoint requests.

The following example demonstrates how to populate the JsonDataSource with data from a web-service endpoint.

C#

using DevExpress.DataAccess.Json;
// ...
public static JsonDataSource CreateDataSourceFromWeb() {
    var jsonDataSource = new JsonDataSource();
    // Specify the endpoint.
    jsonDataSource.JsonSource = new UriJsonSource(new Uri("http://northwind.servicestack.net/customers.json"));
    // Populate the data source with data.
    jsonDataSource.Fill();
    return jsonDataSource;
}

VB.NET

Imports DevExpress.DataAccess.Json
' ...
Public Shared Function CreateDataSourceFromWeb() As JsonDataSource
    Dim jsonDataSource = New JsonDataSource()
    ' Specify the endpoint.
    jsonDataSource.JsonSource = New UriJsonSource(New Uri("http://northwind.servicestack.net/customers.json"))
    ' Populate the data source with data.
    jsonDataSource.Fill()
    Return jsonDataSource
End Function

The following example demonstrates how to populate the JsonDataSource with JSON data from a file.

C#

using DevExpress.DataAccess.Json;
// ...
public static JsonDataSource CreateDataSourceFromFile() {
    var jsonDataSource = new JsonDataSource();
    // Specify the JSON file name.
    Uri fileUri = new Uri("customers.json", UriKind.RelativeOrAbsolute);
    jsonDataSource.JsonSource = new UriJsonSource(fileUri);
    // Populate the data source with data.
    jsonDataSource.Fill();
    return jsonDataSource;
}

VB.NET

Imports DevExpress.DataAccess.Json
' ...
Public Shared Function CreateDataSourceFromFile() As JsonDataSource
    Dim jsonDataSource = New JsonDataSource()
    ' Specify the JSON file name.
    Dim fileUri As New Uri("customers.json", UriKind.RelativeOrAbsolute)
    jsonDataSource.JsonSource = New UriJsonSource(fileUri)
    ' Populate the data source with data.
    jsonDataSource.Fill()
    Return jsonDataSource
End Function

Inheritance

Object

JsonSourceBase

UriJsonSource