Problems with Django REST framework filtering?

Question

I have this problem while using the Django Rest Framework. I am trying to do a get request using patient id. Now, lets say I look for patientid=6, the api returns results with patientid=6 ,patientid=26 and any ids that contain the number '6'. It looks like it searches for a substring.I want to make it work such that patient id=6 returns only the patientid results with id =6

serializers.py

class Radiologypdfserializerdata(serializers.ModelSerializer):

    class Meta:
        model = models.Radiologypdf
        fields = (
            'patientid',
            'testinfo',
            'clinicalindication',
            'attendingdoctor',
            'patientname',
            'age',
            'mobilenumber',
            'sex',
            'email',
            'doctorsname',
            'doctorsregistrationnumber',
            'clinicname',
            'doctorstelno',
            'createdtime',
            'radiology_id',
            'created',

        )

api.py

class RadiologypdfViewSet(viewsets.ModelViewSet):
    """ViewSet for the radiology class"""

    queryset = models.Radiologypdf.objects.all()
    serializer_class = serializers.Radiologypdfserializerdata
    permission_classes = [permissions.IsAuthenticated]

    filter_backends = (filters.SearchFilter,)
    search_fields = ('patientid','radiology_id')

neverwalkaloner · Accepted Answer · 2018-05-25 15:16:44Z

2

You can use django-filter library for this.

Just install it with:

pip install django-filter

And use in your viewset like this:

from django_filters.rest_framework import DjangoFilterBackend

class RadiologypdfViewSet(viewsets.ModelViewSet):
    """ViewSet for the radiology class"""

    queryset = models.Radiologypdf.objects.all()
    serializer_class = serializers.Radiologypdfserializerdata
    permission_classes = [permissions.IsAuthenticated]

    filter_backends = (DjangoFilterBackend,)
    filter_fields = ('patientid','radiology_id')

answered May 25, 2018 at 15:16

neverwalkaloner

47.6k7 gold badges101 silver badges103 bronze badges

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

Comments

Afeef Janjua · Accepted Answer · 2018-05-26 18:34:08Z

0

Excerpt from the docs: http://www.django-rest-framework.org/api-guide/filtering/#searchfilter

The search behavior may be restricted by prepending various characters to the search_fields.

'^' Starts-with search.
'=' Exact matches.
'@' Full-text search. (Currently only supported Django's MySQL backend.)
'$' Regex search.

For example change your code to the following:

`search_fields = ('=patientid','radiology_id')`

edited May 26, 2018 at 18:34

answered May 25, 2018 at 21:06

Afeef Janjua

6597 silver badges10 bronze badges

Comments

Akhil S · Accepted Answer · 2021-06-06 04:49:32Z

0

Since you are already using SearchFilter, you can just prepend "=" to your filter fields. In this case your filter fields would be:

filter_fields = ('=patientid','=radiology_id')

According to the docs:

The search behavior may be restricted by prepending various characters to the search_fields.

'^' Starts-with search.
'=' Exact matches.
'@' Full-text search. (Currently only supported Django's PostgreSQL backend.)
'$' Regex search.

edited Jun 6, 2021 at 4:49

Akhil S

1,19914 silver badges19 bronze badges

answered Mar 19, 2019 at 9:08

Sollych

4395 silver badges12 bronze badges

1 Comment

Jawad Over a year ago

filter_fields do not support = ^ $ ... only search_fields allows you to search based on these options.

Collectives™ on Stack Overflow

Problems with Django REST framework filtering?

3 Answers 3

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related