How to get foreignkey field name instead of id in django rest framework

Question

Here is my models.py

from __future__ import unicode_literals
from django.db import models

class User(models.Model):
    name = models.CharField(max_length=200)
    company_name = models.ForeignKey('Company',on_delete=models.CASCADE,related_name='user')

    def __str__(self):
        return self.name

class Company(models.Model):
    name = models.CharField(max_length=200)
    phone_number = models.IntegerField(null=True,blank=True)

    def __str__(self):
        return self.name

class Catalog(models.Model):
    name = models.CharField(max_length=200)
    no_of_pcs = models.IntegerField(null=True,blank=True)
    per_piece_price = models.DecimalField(null=True,blank=True,max_digits=10,decimal_places=2)
    company_name = models.ForeignKey(Company,on_delete=models.CASCADE,related_name='catalog')

    def __str__(self):
        return self.name

here is my serializers.py

from rest_framework import serializers
from .models import *
from django.db.models import Sum,Count

class UserSerializer(serializers.ModelSerializer):
    # name = serializers.StringRelatedField()
    # company_name = serializers.CharField()
    class Meta:
        model = User
        fields = '__all__'

here is my views.py

from __future__ import unicode_literals
from django.http import HttpResponse
from .models import *
import json
from django.http import JsonResponse, HttpResponse
from .serializers import *
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from rest_framework import viewsets

class UserView(viewsets.ModelViewSet):
    queryset =  User.objects.all()
    serializer_class = UserSerializer

I am getting api like this.. Here i am getting id instead of company_name.

[
    {
        "id": 1,
        "name": "soubhagya",
        "company_name": 1
    },
    {
        "id": 2,
        "name": "nihar",
        "company_name": 2
    }
]

But i am expecting output--

like this:

[
    {
        "id": 1,
        "name": "soubhagya",
        "company_name": "google"
    },
    {
        "id": 2,
        "name": "nihar",
        "company_name": "facebook"
    }
]

I am expecting my api like this. with company_name. And i wants to post the data from same api in rest framework thanks,,

JPG · Accepted Answer · 2018-09-25T05:59:01.200

24

Since you'd defined the __str__() method in your Company model, you can use the StringRelatedField() as

class UserSerializer(serializers.ModelSerializer):
    company_name = serializers.StringRelatedField()
    class Meta:
        model = User
        fields = '__all__'

UPDATE
override the to_representation method

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = '__all__'

    def to_representation(self, instance):
        rep = super(UserSerializer, self).to_representation(instance)
        rep['company_name'] = instance.company_name.name
        return rep

edited Sep 25 '18 at 05:59

answered Sep 25 '18 at 05:48

JPG

82,442
19
127
206

i wants to post also – Kiran S youtube channel Sep 25 '18 at 05:52
TypeError at /users/ super() takes at least 1 argument (0 given) – Kiran S youtube channel Sep 25 '18 at 05:56
use `super(UserSerializer, self).to_representation(instance)` instead `super().to_representation(instance)` – JPG Sep 25 '18 at 05:59
Yes. Using `StringRelatedField()` is the simple one. But, the *comments* says that he needs to do ***write and update*** operations as well – JPG Sep 25 '18 at 06:32

score 10 · Answer 2 · answered Sep 25 '18 at 06:03

10

simple solution is use source

class UserSerializer(serializers.ModelSerializer):
    company_name = serializers.CharField(source='company_name.name')

answered Sep 25 '18 at 06:03

Brown Bear

19,655
10
58
76

1

This is the simplest and one could add a company id as a field so that it could be used for forms in a js page (to represent the "company"). – Harlin May 16 '21 at 22:17

score 4 · Answer 3 · answered Oct 12 '21 at 14:25

4

Use depth.

class PhoneSerializer(serializers.ModelSerializer):
    class Meta:
        model = Phone
        depth = 1
        fields = '__all__'

answered Oct 12 '21 at 14:25

Arindam Roychowdhury

5,927
5
55
63

Exprator · Answer 4 · 2018-09-25T05:55:33.893

3

class UserSerializer(serializers.ModelSerializer):
    company_name = serializers.SerializerMethodField(source='get_company_name')
    class Meta:
        model = User
        fields = '__all__'
    def get_company_name(self, obj):
        return obj.company_name.name

edited Sep 25 '18 at 05:55

answered Sep 25 '18 at 05:48

Exprator

26,992
6
47
59

i wants to post also – Kiran S youtube channel Sep 25 '18 at 05:51
then change it to CharField – Exprator Sep 25 '18 at 05:52
now my company input field is gone.. i need to post data also – Kiran S youtube channel Sep 25 '18 at 05:59
@Exprator for your solution source does not need. – Brown Bear Sep 25 '18 at 06:06

score 1 · Answer 5 · edited Oct 16 '20 at 14:15

1

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = '__all__'

    def to_representation(self, instance):
        rep = super(UserSerializer, self).to_representation(instance)
        rep['company_name'] = instance.company_name.name
        return rep

edited Oct 16 '20 at 14:15

token

903
1
9
23

answered Oct 16 '20 at 12:32

Mrutyunjaya Rout

11
1

score 0 · Answer 6 · answered Jan 09 '22 at 20:32

0

Here is the documentation:

This worked for me:

company_name = serializers.SlugRelatedField(read_only=True, slug_field='name')

answered Jan 09 '22 at 20:32

Dragos Neata

153
7

How to get foreignkey field name instead of id in django rest framework

6 Answers6

Linked