How to allow Enum Description to be used in POST body

Question

We want to allow users to enter the "friendly" name of an Enum when sending a POST request using the Description attribute.

Some of our Enums contain multiple words so basically we want to allow the user to enter the Description rather than the actual Enum name.

For example we have the following Enum class:

public enum PaymentMethodType
{
    [Description("Other")]
    Other = 0,
    [Description("Cash")] 
    Cash = 1,
    [Description("Credit Card")] 
    CreditCard = 2,
    [Description("Debit Card")] 
    DebitCard = 3
}

Request Class:

public class TransactionPaymentDetailRequest
{
    public PaymentMethodType? MethodType { get; set; }
}

And the following request payload:

{
    "TransactionPaymentDetails": [
        {
           "MethodType": "Credit Card"
        }
    ]
}

As the payload comes in we would like "MethodType": "Credit Card" to be mapped to PaymentMethodType.CreditCard.

Any suggestions on how to achieve this?

Hey @Llama, would you be able to elaborate? How would I use JsonConverter in this case. — M0rty, Sep 08 '21 at 05:12
checked the tons of answers of this question? https://stackoverflow.com/questions/59059989/system-text-json-how-do-i-specify-a-custom-name-for-an-enum-value — monty, Sep 08 '21 at 05:12

score 0 · Answer 1 · answered Sep 08 '21 at 06:37

0

Try this：

[JsonConverter(typeof(StringEnumConverter))]
[Required]
public PaymentMethodType? MethodType { get; set; }

for this you need to install the "Newtonsoft.Json" package. You can do that using Visual Studios NuGet Package UI or if coding using shell:

dotnet add package Newtonsoft.Json

and then using them in your class:

using Newtonsoft.Json; //for JsonConverter
using Newtonsoft.Json.Converters; //for StringEnumConverter

answered Sep 08 '21 at 06:37

Tupac

2,590
2
6
19

`StringEnumConverter` uses `EnumMemberAttribute`, not `DescriptionAttribute`. – Dai Sep 08 '21 at 06:40

How to allow Enum Description to be used in POST body

1 Answers1