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?

Answer 1

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.

Answer 2

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

Answer 3

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

});