JSON deserialization in C# - User withheld_in_countries is erroring

[Claire]

I’ve been updating Microsoft’s UWP Community Toolkit implementation of Twitter - it basically provides a bunch of types and methods for interacting with Twitter’s APIs.

For some reason, I’m getting a very sporadic error on the “withheld_in_countries” value that is sometimes present on the user object of a tweet. The problem is, it’s so sporadic that I can’t get it to repro consistently in order to troubleshoot what I’m doing wrong.

I’m serializing this value into a string, which is what the API documentation states is being returned. Should i be using something else?

[abraham]

The TypeScript interface I generated has that listed as being an array of strings if it’s present. Looking at the documentation on Twitter it’s supposed to just be a string that’s comma separated. I can look back through my data sources if you would like a more specific example.

[Claire]

Please, I’d appreciate it - it sounds like Twitter’s documentation might be out-of-date on this particular property of the user object in the returned JSON. If it just needs to be a string[] instead of a string, that’s easy enough to fix.

[andypiper]

I’m not currently able to check, but I’ll do my best to clarify what the field should hold.

[abraham]

Check out tweet 938736239724974081.

{
  "user": {
    "withheld_in_countries": ["XY"]
  }
}

[andypiper]

I’ll make a note to get the documentation on this updated for clarity.

[andypiper]

Actually, just checking, and https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/tweet-object does already describe this as an array of strings - where (else?) are you seeing this documented, in case I’m missing something?

[Claire]

withheld_in_countries is listed here as being a string:
https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/user-object

This is the object that’s throwing an error for me.

[andypiper]

Thanks for clarifying, I’d missed that one. I’d expect it to be consistent between both objects. I’ll confirm with the team that handles user objects asap.

[andypiper]

Confirmed - I’ll get this fixed in the docs, and apologies for the inaccuracy.

[andypiper]