Setting property name to include @ in JSON using System.Text.Json

Question

I need to send via REST (not including some other sensitive information):

{"@Scope": "Local"}

In the class file I JsonProperty for Json.Net serialization:

[JsonProperty("@Scope")]
public string Scope { get; set; }

When putting together the json message to be sent via WebRequest, I have

{@Scope = "Local"}

But after running:

string jsonString = System.Text.Json.JsonSerializer.Serialize(message);

The message being sent out is

{"Scope": "Local"}

For some reason I though System.Text.Json will pick up JsonProperty attributes but apparently there should be some other way.

Does this answer your question? What does the @ symbol before a variable name mean in C#? — quaabaam
– quaabaam, Commented Jun 15, 2021 at 16:51
is this using .net core 3.0? if so try [JsonPropertyName("@Scope")] ? e.g see stackoverflow.com/a/58299628/15410 — Rippo
– Rippo, Commented Jun 15, 2021 at 16:52
@ is not a valid character in C# identifiers itself; it's used as an escape sequence to allow keywords to serve as identifiers. So writing @Scope has the same meaning as just writing Scope; you need to use whatever you'd normally use to override serialization to get such names as literals. — Jeroen Mostert
– Jeroen Mostert, Commented Jun 15, 2021 at 16:52
TFM - How to customize property names and values with System.Text.Json "To set the name of individual properties, use the JsonPropertyName attribute" — Alexei Levenkov
– Alexei Levenkov, Commented Jun 15, 2021 at 16:56

golakwer · Accepted Answer · 2021-06-15 16:54:25Z

1

Try using

[JsonPropertyName("@Scope")]

Instead of

[JsonProperty("@Scope")]

JsonProperty might be for Newtonsoft which the built in serialization library probably does not recognize.

answered Jun 15, 2021 at 16:54

golakwer

3811 silver badge4 bronze badges

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

1 Comment

Thanks for the quick response. This seems to work.