student Homerooms

Patricia Kearns
Patricia Kearns
Third Anniversary Name Dropper Facilitator 1
in Education Management APIs

Is there a way to retrieve the homerooms for students? thank you in advance…

Comments

  • Julian Daniel
    Julian Daniel
    Eighth Anniversary Name Dropper Facilitator 1

    @Patricia Kearns We use Advisory sections for our homeforms. Our Junior School has an Advisory “course code” of “JSHF” and a section “3S” for Grade 3 Mrs Jane Smith's homeform. Or for the Senior School we use 3-letter codes for sections, so SSHF-ABC would be Senior School Homeform ABC.

    I'm not sure if that clears things up… :)

    The only easy way to do this is to use the Student Enrolment endpoint (replace “USERID” with the students user_id, and tack on the appropriate school year):

    https://api.sky.blackbaud.com/school/v1/academics/enrollments/USERID?school_year=2021-2022

    This returns the entire academic/advisory/athletic enrolment for that student, including the Advisory section I mentioned earlier (edited for privacy):

    {
    "begin_date" : "2021-08-05T00:00:00-07:00",
    "block_id" : 17128,
    "block_name" : "Homeform",
    "blocks" : true,
    "building_name" : "JS MB Main Building",
    "changed_sections" : 0,
    "course_code" : "JSHF",
    "course_length" : 1,
    "course_title" : "Junior School Homeform",
    "departments" : [],
    "distinction" : "",
    "dropped" : 0,
    "duration_begin_date" : "2021-08-01T00:00:00-07:00",
    "duration_description" : "Term",
    "duration_end_date" : "2022-06-30T00:00:00-07:00",
    "duration_id" : 152152,
    "duration_name" : "Full",
    "end_date" : "2022-06-30T00:00:00-07:00",
    "faculty_first_name" : "Jane",
    "faculty_last_name" : "Smith",
    "id" : 93917083,
    "level_number" : 1675,
    "offering_description" : "Advisory",
    "offering_id" : 217345,
    "offering_type_id" : 3,
    "room_id" : 42935,
    "room_name" : "Classroom",
    "room_number" : "JS . MB212",
    "school_year" : "2021-2022",
    "section_identifier" : "3S"
    },

  • Patricia Kearns
    Patricia Kearns
    Third Anniversary Name Dropper Facilitator 1

    @Julian DanielThank you Julian…I was considering this however, this will really slow down the student import to make a separate call for each student. Possibly I could have a separate import for just the homerooms…I am also considering using a custom field.

  • Julian Daniel
    Julian Daniel
    Eighth Anniversary Name Dropper Facilitator 1

    @Patricia Kearns for start-of-year mass imports to set up your local database, why not just use a custom list and export as CSV? Once your database is populated, you can do updates on a userid by userid basis.

    Or do a user by role API call for the student role (it will only include current students), then do another API pass to fill in the blanks with schedule info.

    But the API is really too slow and clunky to do a bulk import of hundreds of students - it's very much a work-in-progress, and has been for years. I don't think it was designed by school data admins, because it seems to be more vendor-focussed.

Categories