how to get response with message,error, status in django rest framework

Question

HI Everyone i am creating api using drf but i want response with different formet, below i have mention my current response and expected response.how can achieve me my expected api response formet.

views.py

class TeamlistViewset(viewsets.ViewSet):
    def list (self,request):
        team=Team.objects.all()
        serializer=TeamSerializer(team,many=True)
        return Response(serializer.data)

api response

[
    {
        "id": 1,
        "name": "Deadly Shark"
    }
]

expected api response

{
    "message": "list retrieval",
    "error": false,
    "code": 200,
    "results": {
        "totalItems": 1,
        "pageData": [
            {
                "id": 1,
                "name": "Deadly Shark"
                
            }
        ],
        "totalPages": null,
        "currentPage": 0
    }
}

Karishma Upadhyay · Accepted Answer · 2022-05-12 05:32:19Z

2

this is solution

class DriverlistViewset(viewsets.ViewSet):
    # permission_classes = (IsAuthenticated,)

    def list (self,request):
        team=Team.objects.all()
        serializer=TeamSerializer(team,many=True)
        # headers=self.get_success_headers(serializer.data)
        try:
            return Response({'message':'sucess','error':False,'code':200,'result':{'totalItems':len(serializer.data),'items':serializer.data,'totalPages':'null','currentPage':0}},status=HTTP_200_OK)
        except Exception as e:
            return Response({'message':'fail','error':True,'code':500,'result':{'totalItems':0,'items':[],'totalPages':0,'currentPage':0}})

edited May 12, 2022 at 5:32

answered May 11, 2022 at 5:37

Karishma Upadhyay

1451 silver badge11 bronze badges

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

1 Comment

joanis Over a year ago

Is this a solution for your question, or a clarification? If it's a solution, please edit the answer to say so, if it's a clarification, please edit it into the question.

Ameer Hamza · Accepted Answer · 2023-03-27 09:58:59Z

0

A bit late but you can do it like this

class TeamlistViewset(viewsets.ViewSet):
    def list (self,request):
        team=Team.objects.all()
        serializer=TeamSerializer(team,many=True)
        response = {
           "message": "list retrieval",
           "error": False,
           "code": 200,
           "results": serializer.data
        }
        return Response(response, status=status.HTTP_200_OK)

If you get type error that you cannot send data of Type Team i.e. your model, then serialize the data you receive first. Also it is better to add status code besides the response such as in the last line of the above code and not inside the response dictionary.

edited Mar 27, 2023 at 9:58

answered Mar 27, 2023 at 9:57

Ameer Hamza

263 bronze badges

Collectives™ on Stack Overflow

how to get response with message,error, status in django rest framework

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related