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-25 11:40:00Z

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, 2014 at 11:40

answered Feb 25, 2014 at 11:32

Mikke

2,17717 silver badges22 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Collin Allen Over a year ago

New usage now looks like: RestangularProvider.addResponseInterceptor(function (data, operation, what, url, response, deferred) {

Ed B Over a year ago

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

Thram · Accepted Answer · 2014-04-11 02:56:34Z

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, 2014 at 2:56

Thram

5324 silver badges9 bronze badges

2 Comments

Ed B Over a year ago

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.

Robin Schaaf Over a year ago

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)

Community · Accepted Answer · 2017-05-23 12:34:45Z

6

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;
        });

});

edited May 23, 2017 at 12:34

CommunityBot

11 silver badge

answered Mar 18, 2015 at 0:02

Ouadie

13.2k4 gold badges54 silver badges63 bronze badges

Collectives™ on Stack Overflow

Restangular: getList with object containing embedded array

3 Answers 3

2 Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related