CODEWITHSUNDEEP
javascriptjsonrestdojojsonschema
Rainier Wolfcastle
Rainier Wolfcastle

Reputation: 636

Dojo JsonRestStore with array not at root-level of JSON response

Is there a way to configure a JsonRestStore to work with an existing web service that returns an array of objects which is not at the root-level of the JSON response?

My JSON response is currently similar to this:

{
    message: "",
    success: true,
    data: [
        { name: "Bugs Bunny", id: 1 },
        { name: "Daffy Duck", id: 2 }
    ],
    total: 2
}

I need to tell the JsonRestStore that it will find the rows under "data", but I can't see a way to do this from looking at the documentation. Schema seems like a possibility but I can't make sense of it through the docs (or what I find in Google).

My web services return data in a format expected by stores in Ext JS, but I can't refactor years worth of web services now (dealing with pagination via HTTP headers instead of query string values will probably be fun, too, but that's a problem for another day).

Thanks.

Upvotes: 0

Views: 243

Answers (2)

Ken Franqueiro
Ken Franqueiro

Reputation: 10559

While it's only barely called out in the API docs, there is an internal method in dojox/data/JsonRestStore named _processResults that happens to be easily overridable for this purpose. It receives the data returned by the service and the original Deferred from the request, and is expected to return an object containing items and totalCount.

Based on your data above, something like this ought to work:

var CustomRestStore = declare(JsonRestStore, {
    _processResults: function (results) {
        return {
            items: results.data,
            totalCount: results.total
        };
    }
});

Upvotes: 2

Dylan
Dylan

Reputation: 86

The idea with dojo/store is that reference stores are provided, but they are intended to be customized to match whatever data format you want. For example, https://github.com/sitepen/dojo-smore has a few additional stores (e.g. one that handles Csv data). These stores provide good examples for how to handle data that is offered under a different structure.

There's also the new dstore project, http://dstorejs.io/ , which is going to eventually replace dojo/store in Dojo 2, but works today against Dojo 1.x. This might be easier for creating a custom store to match your data structure.

Upvotes: 0

Related Questions