Django Rest Framework, passing parameters with GET request, classed based views

Question

I would like a user to send a GET request to my Django REST API:

127.0.0.1:8000/model/?radius=5&longitude=50&latitude=55.1214

with his longitude/latitude and radius, passed in parameters, and get the queryset using GeoDjango.

For example, currently I have:

class ModelViewSet(viewsets.ModelViewSet):
    queryset = Model.objects.all()

And what I ideally want is:

class ModelViewSet(viewsets.ModelViewSet):
     radius = request.data['radius']
     location = Point(request.data['longitude'],request.data['latitude']
     # filter results by distance using geodjango
     queryset = Model.objects.filer(location__distance_lte=(location, D(m=distance))).distance(location).order_by('distance')

Now a couple of immediate errors:

1) request is not defined - should I use api_view, i.e. the function based view for this?

2) DRF page says that request.data is for POST, PUT and PATCH methods only. How can send parameters with GET?

The modelviewset has a few methods where you can access the REQUEST parameter. Like def get_queryset(self) - self.request, which is probably where you should put your code. Try this and let me know — Walucas
– Walucas, Commented Jan 17, 2018 at 11:10

cavalcantelucas · Accepted Answer · 2020-03-27 09:05:48Z

151

You can override get_queryset method for that purpose. As for query string parameters, you are right, request.data holds POST data, you can get query string params through request.query_params

def get_queryset(self):
    longitude = self.request.query_params.get('longitude')
    latitude= self.request.query_params.get('latitude')
    radius = self.request.query_params.get('radius')

    location = Point(longitude, latitude)

    queryset = Model.objects.filter(location__distance_lte=(location, D(m=distance))).distance(location).order_by('distance')

    return queryset

edited Mar 27, 2020 at 9:05

cavalcantelucas

1,3943 gold badges13 silver badges35 bronze badges

answered Jan 17, 2018 at 11:11

Ozgur Akcali

5,5222 gold badges35 silver badges51 bronze badges

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

6 Comments

GRS Over a year ago

This worked but I had to add router.register(r'model_name', views.ModelViewSet , base_name='model_name') in urls.py. However, now POST request gives me the following error: Could not resolve URL for hyperlinked relationship using view name "model-detail". You may have failed to include the related model in your API, or incorrectly configured the lookup_field attribute on this field.

saran3h Over a year ago

what if i pass a boolean param? self.request.query_params.get returns a string. Is there a clean way to get boolean params? or should i do a string comparison?

Ozgur Akcali Over a year ago

@saran3h I do not think that there is a way to directly get a boolean value from query_params, you problably should do string comparison in that case.

kommradHomer Over a year ago

request.data does not hold POST data exclusively. If you make a GET request with x-www-urlencoded and use body , request.GET and request.query_params are empty and the data is held in request.data

cgitosh Over a year ago

This is my url path('consignmentdocs/<uuid:pk>/', ConsignmentDocsListViewSet.as_view(), name='consignment-docs'), how do I get the pk using query_params to use in filtering a Model?

|

Anhad · Accepted Answer · 2023-07-06 06:24:27Z

5

use this simplest way you can get query param values:

request.GET.get("radius")

edited Jul 6, 2023 at 6:24

answered Jul 6, 2023 at 4:30

Anhad

1212 silver badges4 bronze badges

Comments

farch · Accepted Answer · 2021-08-06 20:33:37Z

4

I had the same problem, to solve it you can get parameters from url with self.request.parser_context.get('kwargs') under the get_queryset method.

answered Aug 6, 2021 at 20:33

farch

5116 silver badges17 bronze badges

Comments

Codertjay · Accepted Answer · 2022-10-27 19:18:09Z

0

this actually worked for me . using the self.request.query_params.get("lead_contact_id")

def get_queryset(self,*args,**kwargs):
    # the lead id
    lead_contact_id = self.request.query_params.get("lead_contact_id")
    #  this filter base on the lead id  provided
    feedback = Feedback.objects.filter(object_id=lead_contact_id)
    return feedback

answered Oct 27, 2022 at 19:18

Codertjay

1,0871 gold badge14 silver badges20 bronze badges

Collectives™ on Stack Overflow

Django Rest Framework, passing parameters with GET request, classed based views

4 Answers 4

6 Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

6 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related