Skip to content

Latest commit

 

History

History
406 lines (256 loc) · 22.7 KB

CHANGELOG.md

File metadata and controls

406 lines (256 loc) · 22.7 KB

Changelog for SKYAPI PowerShell Module

0.4.3 - (2025-02-19)

Fixes

  • This update continues to try work around the Get-SchoolScheduleMeeting bug. We dropped each API call from 30 days ahead max to 29 days ahead, but the endpoint will still not return meetings for the last day requested (the 30th total day in the range, 29 days after start_date).

Author: @Sekers

0.4.2 - (2025-02-19)

Fixes

  • This update only adjusts Get-SchoolScheduleMeeting so that it doesn't get affected by a DST bug with its Blackbaud SKY API endpoint. Prior to this workaround, if any 31-day or larger query (the max of 30 days ahead the endpoint allows, including the start date) has the March DST "Spring forward" date in one of the API calls (remember, each call can only accept a max of 30 days ahead), it won't return the last day of that specific API call (the 31st day in the range). Blackbaud certainly has an issue working with timezones and calculating around DST properly (given, it's tough at times).

Author: @Sekers

0.4.1 - (2025-02-04)

Fixes

  • BREAKING CHANGE: The endpoint that Get-SchoolYear uses has a bug that sets each school year's 'begin_date' & 'end_date' to the incorrect time zone, which could cause the date returned to be incorrect (even if you adjust to the school's Blackbaud time zone). To work around this, these fields now return a STRING of the date (e.g., '2025-05-24') instead of a DATETIME value (PS Core) or an unserialized round-trip STRING that includes the time (PS Desktop; e.g., '2025-07-04T00:00:00-04:00').

Features

  • Continue to improve invoke API error handling by catching two additional types of errors.

Author: @Sekers

0.4.0 - (2025-01-22)

Fixes

  • Resolved bug in PS Core (PS Desktop was fine) when calling Get-SchoolScheduleMeeting if one of the 30-day iterations comes back empty.

Features

  • Sample script for Google Faculty Calendar Imports now supports meeting exclusions.

  • Improved error handling. Some errors that can often be transient now retry using an exponential backoff rather than just retrying up to 5 times with a 5-second delay in-between. This should reduce how often scripts fail by increasing the retry count from 5 to 7 and increasing the max wait time from the first try to the last retry from 20 seconds to just over 5 minutes. The exponential backoff delay is as follows (in seconds):

    Failure Count Wait Time Before Next Retry Total Wait Time
    1 5 5
    2 10 15
    3 20 35
    4 40 75
    5 80 155
    6 160 315
    7 n/a (throws error) 315

Other

  • Disabled progress bar in function scope when calling Invoke-WebRequest or Invoke-RestMethod. This improves performance due to a bug in some versions of PowerShell. It was eventually fixed in Core (v6.0.0-alpha.13) but still is around in Desktop. More Information: PowerShell/PowerShell#2640
  • Removed the unimplemented 'MiniHTTPServer' alternate method of capturing authentication as this would be overkill and is unnecessary.
  • Removed the 'LegacyIEControl' alternate method of capturing authentication as it is no longer supported by Blackbaud.

Author: @Sekers

0.3.11 - (2024-10-14)

Features

  • BREAKING CHANGE: Updated the included Microsoft Edge WebView2 control to version 1.0.2792.45. Note that the minimum .NET Framework version requirement for .NET WebView2 has been updated from .NET Framework 4.5 to .NET Framework 4.6.2 (this affects Windows PowerShell Desktop only, not PowerShell Core).
  • New Endpoint: Get-SchoolAdmissionCandidate
  • New Endpoint: Get-SchoolAdmissionStatus
  • New Endpoint (Currently Beta): Get-SchoolActivityRoster
  • New Endpoint (Currently Beta): Get-SchoolAdvisoryRoster
  • New Endpoint (Currently Beta): Get-SchoolRoster
  • Added new parameters to Set-SchoolUserRelationship: resides_with, do_not_contact, primary, & comments
  • Updates to error handling as the Blackbaud SKY API now returns at least 4 different types of error message formats.
  • New sample script: Blackbaud SIS Teacher Schedules to ICS

Other

  • Updated links for built-in help to new endpoint documentation URLs.
  • Updated authorize URI in various places due to updates on the API end (the old URI still works since it is forwarded to the new one).
  • Minor example and built-in help updates, clarifications, and typo fixes.
  • Removed references to resolved Blackbaud API DATETIME bug.
  • Removed temporary fix for now resolved bad email bug in the endpoint for Update-SchoolUser.

Author: @Sekers

0.3.10 - (2023-03-21)

Fixes

  • Resolved bug where Get-SchoolScheduleMeeting returned an error after DST begins in time zones that practice advancing clocks during warmer months.

Features

Other

  • Updated links in README to Blackbaud API documentation as the documentation website had slightly changed structure.
  • A few minor example and built-in help updates, clarifications, and typo fixes.
  • Removed the 'links' parameter from New-SchoolUserPhone as Blackbaud never actually implemented this feature in the endpoint and updated their documentation. See the February 28, 2023 Education Management API changelog for further information.

Author: @Sekers

0.3.9 - (2023-03-06)

Features

Other

  • Built-in help updates regarding necessary permissions to access some endpoints (Blackbaud loosened the requirements on a bunch of general information ones).

Author: @Sekers

0.3.8 - (2023-02-13)

Fixes

  • Resolved bug where Get-SchoolScheduleMeeting returned duplicate events every 30th day of the requested range.

Author: @Sekers

0.3.7 - (2023-02-02)

Breaking Changes

  • Beta cmdlet/function Get-SchoolScheduleMeeting now returns meeting start/end times in UTC so that there are no time zone issues. See the built-in help or examples file to see ways to convert to the local time or a specific time zone.

Fixes

  • Worked around a time zone bug in the beta API endpoint used by Get-SchoolScheduleMeeting so that the cmdlet/function always correctly handles Daylight Saving Time adjustments.

Features

  • New Endpoint: Get-SchoolTimeZone
  • Get-SchoolScheduleMeeting now accepts the following new option parameter values: section_ids & last_modified.
  • Updated the included Microsoft Edge WebView2 control to version 1.0.1518.46.
  • With this new version of the WebView2 control, we can now use the control to natively clear the browser cache. If the version of the Edge WebView2 runtime installed on the computer (this is different than the WebView2 control included with the module) is too old, the SKYAPI PowerShell module will use the old method of deleteing the entire WebView2 control's profile for the user account used by the process.

Other

  • Minor fixes, such as the ability to handle certain transient errors returned by the API servers.

Author: @Sekers

0.3.6 - (2023-01-19)

Fixes

  • HOTFIX: Resolved issue where error was presented on some endpoints when DateTime fields are returned empty.

Author: @Sekers

0.3.5 - (2023-01-19)

Fixes

  • Resolved issue with the 'dob' parameter in the Update-SchoolUser function so it accepts a string.
  • Fixed a format issue with the response of Get-SchoolSectionByStudent.

Features

  • Most endpoints now support the optional 'ReturnRaw' switch parameter to return the original JSON response from the Blackbaud SKY API. Otherwise, they will usually return the data in a custom PSObject or Hashtable object that has a property for each field in the JSON string.
  • New optional 'ConvertTo' parameter for Get-SchoolList that tells the function to instead return the list collection results as an Array of PowerShell objects rather than the wonky, hard-to-work-with, way the API returns list results collections.
  • New Endpoint: Get-SchoolAssignmentBySection
  • New Endpoint: Get-SchoolAssignmentByStudent
  • New Endpoint: Get-SchoolCycleBySection
  • New Endpoint: New-SchoolUserOccupation

Other

  • Created an internal function to try and correct issues with the way DateTime fields are improperly handled by the API until Blackbaud resolves the problems.

Author: @Sekers

0.3.4 - (2022-12-05)

Fixes

  • Stopped sending an erroneously sent parameter to the Get-SchoolList Blackbaud SKY API endpoint. It doesn't affect anything but is unnecessary.
  • Made the 'number' & 'type_id' parameters of the New-SchoolUserPhone function mandatory as the API endpoint requires them.

Features

Other

  • Fixed the casing of some passed/passthru parameters to the Blackbaud SKY API lowercase to match the API documentation as they had accidentally been made camelcase like non-API passed parameters.

Author: @Sekers

0.3.3 - (2022-11-26)

Features

  • Module now works with POST & PATCH endpoints, thus allowing for NEW-* & UPDATE-* PowerShell functions against the SKY API.
  • New Endpoint (Beta): Get-SchoolUserMe
  • New Endpoint: Get-SchoolUserOccupation
  • New Endpoint: Get-SchoolUserRelationship
  • New Endpoint: Get-SchoolVenueBuilding
  • New Endpoint: Get-SKYAPIContext > Returns cached information about the current connection to the Blackbaud SKY API.
  • New Connect-SKYAPI Parameter: ReturnConnectionInfo. Returns values when verifying the cached SKY API connection information.

Other

  • Made all function/cmdlet names consistent as singular (and some other adjustments) & removed the 'List' keyword from function names (as Blackbaud has moved away from using that descriptor and it's also unnecessary). The old function names are kept as aliases so there are no breaking changes due to these renames.
  • Finished renaming all internal functions to prevent any naming conflicts with other modules.

Author: @Sekers

0.3.1 - (2022-11-24)

Fixes

  • Resolved erroneous error message that sometimes appears when using New-SchoolUserPhone.

Author: @Sekers

0.3.0 - (2022-11-24)

Fixes

  • Made the Connect-SKYAPI ClearBrowserControlCache parameter available only if ForceReathentication is used.
  • When the Connect-SKYAPI ClearBrowserControlCache parameter is used, it will no longer return an error if the WebView folder doesn't exist.
  • Removed Write-Verbose message from the Get-SKYAPIConfig function that was accidentally left in the code.

Features

Other

  • Renamed a backend function to prevent possible conflicts with other modules.
  • Removed the prerelease string from the module manifest.
  • Minor updates to the SKYAPI_Example.ps1 script.
  • Module will wait and then try again a few times if a 503 (The service is currently unavailable) is returned to allow for transient issues with the API service.

Author: @Sekers

0.2.6b - (2022-08-11)

Fixes

  • Updated Minimum PS Version to 5.1 to resolve GitHub action issue when publishing to the PowerShell Gallery.

Author: @Sekers

0.2.6 - (2022-08-11)

Features

Author: @Sekers

0.2.5 - (2022-07-28)

Fixes

  • Module now cleans up unused memory allocated to the Microsoft Edge WebView2 form when no longer needed

Features

Author: @Sekers

0.2.4 - (2022-06-08)

Fixes

  • Attempted to prevent the MarkerType type error message if it is somehow preloaded (e.g., your IDE preloading it for some reason)

Features

  • Replaced the soon to be deprecated WebBrowser Class (IE popup window for authentication & authorization) with the Microsoft Edge WebView2 control. See Issue #7.
  • Added the "AuthenticationMethod" parameter to the "Connect-SKYAPI" cmdlet which let's you specify how you want to authenticate if authentication is necessary:
    • EdgeWebView2 (default): Opens a web browser window using Microsoft Edge WebView2 for authentication. Requires the WebView2 Runtime to be installed. If not installed, will prompt for automatic installation.
    • LegacyIEControl: Opens a web browser window using the old Internet Explorer control. This is no longer supported by Blackbaud.
    • MiniHTTPServer (coming soon as a beta feature): Alternate method of capturing the authentication using your user account's default web browser and listening for the authentication response using a temporary HTTP server hosted by the module.

Author: @Sekers

0.2.3 - (2022-06-02)

Fixes

  • Resolved pagination issues when 1,000 or more records were returned using Get-SchoolList or Get-SchoolUserExtendedList

Features

Author: @Sekers

0.2.2 - (2022-06-02)

Fixes

  • Fixed issue with manifest file (typo preventing module from loading)

Author: @Sekers

0.2.1 - (2022-06-01)

Fixes

  • Fixed rare bug on a couple of endpoints that use the Marker parameter

Features

  • Improved Invoke Error Handling
  • New Endpoint: Get-SchoolList - Replaces the soon to be deprecated Legacy List endpoint. The 'Get-SchoolLegacyList" cmdlet will continue to work as expected using this new endpoint.

Other

  • Cleaned up unused variables
  • Removed helper functions from module manifest as they don't need to be called manually
  • Reduced wait time before retrying (500) internal server errors

Author: @Sekers

0.2.0 - (2021-11-15)

Fixes

  • Issue 1 - Updated Web Control Browser Emulation to be more compatible with authentication authorization pages that don't like IE 7 emulation mode (e.g., when using Google SSO).

Author: @Sekers

0.1.1 - (2020-10-05)

Features

  • Initial documentation release

Author: @Sekers

0.1.0 - (2020-10-05)

Features

  • Initial public release

Author: @Sekers