Sky API - Dorm Supervisors, No way to pull the information in the SkyAPI

Kyle McMullin

I'm trying to pull the Dorm Supervisor information and while I can pull down a list of the dorm supervisors, and a list of the Dorm residents, the Dorm Supervisor is not on the Residents list as they are not in a Room and it only lists students that are in a room (this also seems wrong)


So the question is, how to I get from the Sky API what Dorm Supervisor is in what Dorm?

Brian Gray

Kyle McMullin‍ - in many cases, the easiest/only way to do this sort of thing is to build an Advanced List, and then use the Legacy List endpoint to read the list's data into your program.


In this case, the list objects include:

and the list fields include:

After the list is built, you must grant access to the role Web Services API Manager.


On the page of lists, click the Role Access link for the list and add that role.

The Legacy List endpoint requires the list's ID number.

Brian Pugh

Brian, where can we find the role id's, list id's for all lists in Core, RE NXT, etc.?


Thanks very much.



Brian

Brian Gray

For Core, you can get the list of roles and IDs from the Role List endpoint (https://developer.sky.blackbaud.com/docs/services/school/operations/v1rolesget)


Beware...some other endpoints expect the base role ID and others expect the role ID. Both are returned by a call to the Role List endpoint. You just have to know which one to use in each case. (The documentation for each endpoint says that, but it's essential that you always use the correct one.)


I haven't done any work in the RE or FE APIs, so I don't know (yet) how the roles work there.

Brian Pugh

Your answer is very helpful, Brian. And thank you, also, for your warning too.


Brian