Embarrassed to ask... id's, values, etc?

Brian Pugh
Brian Pugh
Ninth Anniversary Kudos 1 Name Dropper Facilitator 1
in Education Management APIs

I am emarrassed to ask where we can find the values and ID's need to run an api. For example, to run: https://api.sky.blackbaud.com/school/v1/attendance?level_id={level_id}&day={day}&offering_type={offering_type}[&excuse_type], I need the level id, day, offering type, and excuse type. (Please see another example, attached, highlighted items.) No doubt a “can't see the forest for the trees.”

7c9a900f09c4ca21db7623cb8bf5bccc-huge-va

Comments

  • Ashley Moose
    Ashley Moose Blackbaud Employee
    Eighth Anniversary Kudos 5 First Reply Name Dropper

    Hi @Brian Pugh - In order to find these values, you need to understand the type of record you are working with. Here we are working with an attendance record so if you are not sure of the values, a good first step is to view an attendance record or attendance list within Education Management directly.

    In this specific example we can get some of these values from other API endpoints. For example,

    Day is referring to the specific day you are looking to get attendance on so that just requires passing a date value such as 2024-07-10.

    And last is Offering Type which I don't see immediately available through any of the endpoints. If I check the Class Attendance List within Education Management though there is a column available for Offering Type so I can see what applicable values would be from there.

    Depending on your role, it may require you to partner with an SME in the specific area you are looking to call an API endpoint for to better understand the data types and what the applicable values would be.

  • Stephen Boyle
    Stephen Boyle Blackbaud Employee
    Tenth Anniversary Kudos 5 First Reply Name Dropper

    @Ashley Moose
    Offering types is here:
    https://developer.sky.blackbaud.com/api#api=school&operation=v1offeringtypesget

    Typically you just need the Academics offering type, which is 1. But if you take attendance in Activities (2) or Advisories (3), then you can do that with the attendance Post as well.

  • Ashley Moose
    Ashley Moose Blackbaud Employee
    Eighth Anniversary Kudos 5 First Reply Name Dropper

    Thank you @Stephen Boyle! I thought the endpoint was out there but I completely overlooked it.

Categories