Single API for Users with Relationships and Related User Details?

You will probably not get everything you are looking for in a single call to the API.

My approach for what you describe is to call the User Extended Get endpoint with multiple base_role_id values (a string that is a comma-separated list of base_role_id values). The Relationships array that is returned as part of the data for each user will include family relationships as defined on the Contacts tab of the user's record in Core. This may include parents, guardians, siblings, grandparents, etc.

My program reads all of the user records and stores them in a hashtable (key = user's ID field). The relationships include the user IDs for both people, so when I am processing a student's record I can cycle through the relationships and do a lookup based on the user ID of the people in the relationships of interest.

The Relationship array does NOT include a student's teachers, advisors, coaches, etc. Those relationships are recorded in the roster of groups that the student is part of.

Few uses have just one role. The All School role (base_role_id 1) is applied to all records. Current users will usually have at at least one other role (Student, Parent, Teacher, etc). It's common for employees to have many roles.

For me, if a record has the Student role, then the user is a student - regardless of what other roles are also assigned to the user. That may or may not make sense for your project.

@Dakshesh Dave

To add to this: A school can create their own roles based on a base role. Here's an example….

Out of the box, not all employees are included in Blackbaud's OneRoster exports. Only teachers are. Blackbaud determines who's a teacher by looking for users with the Teacher base role.

Some schools want to include non-teaching staff as well. So, they've created their own custom role based on the Teacher base role. They assign that role to their non-teaching staff. Then Blackbaud includes them in the exports.

That's one example, anyway. … Hope something here helps!

No problem!

If you let schools pick their own roles, I'd say yes, do what you suggested. Use role_id in combination with /users/extended. Get all users from /users/extended and then filter on your side.

So, in your /users/extended call, set base_role_ids to 1. That will fetch all users in the school. Then filter on roles.

Say one of the users in the /users/extended response has these roles:

"roles": [

    {

        "id": 5559992,

        "base_role_id": 1,

        "hidden": false,

        "name": "All School"

    },

    {

        "id": 8880001,

        "base_role_id": 14,

        "hidden": false,

        "name": "Student"

    }

]

Those ID values match the school-specific role IDs from /roles.

Let's say that school had asked you to sync only the Student role. Their Student role ID is 8880001. So, you could filter your /users/extended response to only include users where any of their roles had ID 8880001.

It's too bad /users/extended doesn't have a role_ids parameter as an alternative to base_role_ids. role_ids would let you get the exact data you need; the filtering would happen on Blackbaud's side. /users does have role_ids as you've probably seen, but it doesn't have all the data you need. So, I'd say /users/extended with filtering on your side is probably your best option.

Sure thing! Yes, all roles always have a base role ID.