Users Extended Role - Users status flag

Giovanni Franco

Hi there, I am using the following endpoint and on the JSON result, I can't find the status of the user whether is active or inactive. Thank you for any hint.

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

Crystal Bruce

Hi @Giovanni Franco I'm tagging in @Stephen Boyle for any insight he can offer. Thanks!

Stephen Boyle

Users don't have a status like that. Users are the main person record. If you are looking for the student status or the candidate status you can determine that through different endpoints.

What type of status are you looking for?

Giovanni Franco

I am looking for users regardless of the role. Parent, student, teacher, etc. etc. Thank you.

Stephen Boyle

You can use the all School role, base roll ID = 1

Giovanni Franco

I am using this one and I do not see any status field for a user. Thank you.

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

Stephen Boyle

There is no status field. Users simply exist as users. I'm not sure what you are looking for.
What would you want the status field you are seeking to tell you? What is it a status for?

Giovanni Franco

If I query against current status, there is no way I can filter active users or inactive, I have to use a different method, having a status field makes a different.

Stephen Boyle

Do you mean you need a field that indicates whether the user can log in to the system?
Or do you mean you need to know if they are currently a student (or a parent of a current student, etc.)?
Or do you mean you need to know if they are currently a candidate?

There isn't a status field for a user, but there are things a user might be connected with that would have a status. Often, you simply need to look at the roles array on the user extended response to see what kind of user it is.

Giovanni Franco

I understood what are you referring too, but I was looking for that specific information.
Thank you for the educational process.