nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Best endpoint(s) for faculty data?

Typecode LLC

I have a few use cases that I'm having trouble discerning the best way to retrieve this data as there seems to be little connection between navigating the blackbaud dashboard and the API structure, any help would be great!

GET all faculty, ideally with these fields: basic details (first name, last name, etc), education information, email/phone, job title, departments (which seems like its buried in something called access > employment?), public bio
GET all faculty filtered by “department” with the above fields
GET a single faculty by id with the above fields

Find more posts tagged with

Comments

Brian Gray

@Typecode LLC

GET all faculty, ideally with these fields: basic details (first name, last name, etc), education information, email/phone, job title, departments (which seems like its buried in something called access > employment?), public bio

The endpoints Users extended by role(s) endpoint has most of this information. Users extended by role(s) takes an argument that is a string of comma-separated BASE role IDs. The base role ID for Teacher is 15.

the public bio field is caller Personal Bio
the job title is in the Occupation section
I don’t see any access to department assignments in any API calls. You can create an Advanced List to extract that info, and read the list with the List Single endpoint.

GET all faculty filtered by “department” with the above fields

I don’t see any option to filter any API call by department. The best way to do that is to use the Advanced List to get the user and department info that you want, and then get the rest of the info from the User Extended data.

GET a single faculty by id with the above fields

The Users extended by user endpoint takes a User ID to return most of the info you’re looking for.

In many of my programs, I first make a call to User Extended by role(s) and read all of the data into a hashmap (key = User ID, data = the User record). Then, when I get the other info I need (via other calls to the API or by reading the advanced list, I can access the User Extended data by lookup in the hashmap.

Typecode LLC

@Brian Gray thank you! We came to a similar conclusion that there's no way to do with without multiple API calls per user (yuck!)

For anyone else that ends up here we found department buried under employment in our case (not sure if that's setup specific): GET users/{user_id}/employment

We actually want all faculty and staff and that spans multiple and changing role ids, so doing that via role id is not really feasible (GET users/extended?base_role_ids={role_id}). Instead we're using the directory endpoint which is in beta and might be deprecated: GET directories/{directory_id}

Brian Gray

@Typecode LLC - For Get Directories, what is the directory ID? Where do you find the correct ID value?

Typecode LLC

@Brian Gray I think this is configuration dependent, but our client has created Directories and manually added various users to them. You can do a manual/postman GET on directories to get the list and IDs and then we hardcode those IDs to constants and use them dynamically as needed.

Brian Gray

@Typecode LLC - Got it. Thanks.