Restangular: getList with object containing embedded array

Question

In my AngularJS project I'm trying to use the Restangular getList method but it's returning an error because the API response is not directly an array but an object containing an array.

{
  "body": [
    // array elements here
  ],
  "paging": null,
  "error": null
}

The Restangular error message is:

Error: Response for getList SHOULD be an array and not an object or something else

Is it possible to tell Restangular that the array it's looking for is inside the body property?

Mikke · Accepted Answer · 2014-02-25T11:40:00.407

22

Yes, see the Restangular documentation. You can configure Restangular like so:

rc.setResponseExtractor(function(response, operation) {
    if (operation === 'getList') {
        var newResponse = response.body;
        newResponse.paging = response.paging;
        newResponse.error = response.error;
        return newResponse;
    }
    return response;
});

Edit: It seems Restangular's API is now changed, for the better, and that the current method to use is addResponseInterceptor. Some adjustments might be needed to the function passed.

edited Feb 25 '14 at 11:40

answered Feb 25 '14 at 11:32

Mikke

2,167
16
22

10

New usage now looks like: `RestangularProvider.addResponseInterceptor(function (data, operation, what, url, response, deferred) {` – Collin Allen Apr 02 '14 at 18:00
1

If you want to avoid changing the Restangular config for all your API calls you can create and use a custom config instead, [as described in the docs](https://github.com/mgonto/restangular#how-to-create-a-restangular-service-with-a-different-configuration-from-the-global-one) – Ed B Aug 12 '15 at 01:49

score 19 · Answer 2 · answered Apr 11 '14 at 02:56

19

I think you should use a the customGET from the Custom Methods

Restangular.all("url").customGET(""); // GET /url and handle the response as an Object

answered Apr 11 '14 at 02:56

Thram

512
4
9

3

This is a great solution if only one of your API calls returns an object. Saves you from having to change Restangular's config globally, and also from creating a custom config (in a factory) for an isolated use case. – Ed B Aug 12 '15 at 01:45
This also works if you use solr and get a number of records returned that you need to keep (whereas using an interceptor with getlist you still need to remove it) – Robin Schaaf May 22 '17 at 15:32

score 6 · Answer 3 · edited May 23 '17 at 12:34

as Collin Allen suggested you can use addResponseInterceptor like this:

    app.config(function(RestangularProvider) {

        // add a response intereceptor
        RestangularProvider.addResponseInterceptor(function(data, operation, what, url, response, deferred) {
          var extractedData;
          // .. to look for getList operations
          if (operation === "getList") {
            // .. and handle the data and meta data
            extractedData = data.body;
            extractedData.error = data.error;
            extractedData.paging = data.paging;
          } else {
            extractedData = data.data;
          }
          return extractedData;
        });

});

Restangular: getList with object containing embedded array

3 Answers3

Linked