Unexpected/Undocumented data returned in UserExtendedGet

Brian Gray
Brian Gray Community All-Star
Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge
in Education Management APIs

User Extended by Role and User Extended by user started to return an unexpected value today. For example,

https://api.sky.blackbaud.com/school/v1/users/extended/3122235

and

https://api.sky.blackbaud.com/school/v1/users/extended?base_role_ids=14

return in part:

"in_state": {

"resident": "No Answer",

"county": "",

"from_date": "0001-01-01T00:00:00-06:00"

},

The “resident” field is supposed to be a string representing a boolean - Yes/No, True/False. “No Answer” is not a boolean, and can not be parsed as one. This breaks SKYLib-Net (the library that I use to read the data), and therefore a large number of my programs.

This kind of breaking change should have been announced. Help!!

Case submitted: 019553839

Comments

  • Stephen Boyle
    Stephen Boyle Blackbaud Employee
    Tenth Anniversary Kudos 5 First Reply Name Dropper

    @Brian Gray
    My apologies. That change notification was supposed to be included in our What's new and our Changelog for 12/5. I didn't get the updates to our docs team in time for it to go out before the release itself went live.

    The in_state object was only recently added and the bug regarding the output of the resident field (not matching the UI of Yes, No and No answer) meant a datatype change was required.

  • Steven Cinquegrana
    Steven Cinquegrana
    Tenth Anniversary Kudos 2 Name Dropper Participant

    @Stephen Boyle Are you saying that the resident field should now be treated as a string restricted to just those three options (True, False, No Answer)? Or can it have additional values?

  • Steven Cinquegrana
    Steven Cinquegrana
    Tenth Anniversary Kudos 2 Name Dropper Participant

    @Brian Gray Agreed; all breaking changes should be per-announced with at least some time between the announcement and the actual change roll out.

  • Stephen Boyle
    Stephen Boyle Blackbaud Employee
    Tenth Anniversary Kudos 5 First Reply Name Dropper

    @Steven Cinquegrana
    Yes. It is a string field now. With possible values of Yes, No, and No answer to match the UI. The correction was made to the User post and patch as well.

Categories