How can i access QueryString values in Serializer Django Rest Framework

Question

I am trying to access querystring values in serializer class.

class OneZeroSerializer(rest_serializer.ModelSerializer):

    location = rest_serializer.SerializerMethodField('get_alternate_name')

    def get_alternate_name(self, obj):
        view = self.context['view']
        print view.kwargs['q']  #output is {}
        return 'foo'


    class Meta:
        model = OneZero

        fields = ('id', 'location')

Views

class OneZeroViewSet(viewsets.ModelViewSet):

   serializer_class = OneZeroSerializer

   queryset = OneZero.objects.all()

Is this right way to access querystring?

Denis Cornehl · Accepted Answer · 2020-02-01 10:31:02Z

36

When using ViewSets, you can access the request in the serializer context (like you access the view). You can access the query params from this

def get_alternate_name(self, obj):
    request = self.context['request']
    print request.query_params['q']
    return 'foo'

The attribute view.kwargs contains the named arguments parsed from your url-config, so from the path-part.

edited Feb 1, 2020 at 10:31

answered Apr 11, 2014 at 14:40

Denis Cornehl

4,2321 gold badge22 silver badges24 bronze badges

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

2 Comments

lukik Over a year ago

For newer versions: request.QUERY_PARAMS has been deprecated in favor of request.query_params since version 3.0, and has been fully removed as of version 3.2.

JustABeginner Over a year ago

I would suggest using request.query_params.get('q') so it won't raise an exception.

chris Frisina · Accepted Answer · 2023-10-15 15:15:12Z

9

According to the docs you want to use self.request.query_params

You can see it being used here

DEPRECATED:

Prior to DRF 3.0:

The usage of request.QUERY_PARAMS is used and not the lowercased request.query_params

edited Oct 15, 2023 at 15:15

chris Frisina

19.3k24 gold badges91 silver badges173 bronze badges

answered Apr 11, 2014 at 8:50

rockingskier

9,3763 gold badges42 silver badges49 bronze badges

2 Comments

Shoaib Ijaz Over a year ago

This is the error when i printed this command 'OneZeroSerializer' object has no attribute 'request'. I think this can be use in viewset not for Serializer Class

rockingskier Over a year ago

Ah yes, misread what was going on. Serializers aren't tied to requests, you can use them separately if you so chose. These means they have no concept of GET and POST data. You need to modify your view to send the query params to the serializer.

ramwin · Accepted Answer · 2017-05-15 07:09:25Z

5

self.context['request'].query_params

answered May 15, 2017 at 7:09

ramwin

6,3433 gold badges31 silver badges35 bronze badges

Collectives™ on Stack Overflow

How can i access QueryString values in Serializer Django Rest Framework

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