Revision history

Date of Change	Summary of Change
15 February 2022	Added revision history Added new API functions: `GetPersonListByClassID`, `GetCoursesByPersonID`, `GetPersonInfoByStudentID`, `GetPersonInfoByName`, `GrantCreditBySignupID`, `ConvertUserToSSOByPersonID`, `ConvertUserToSSOByUserID` Added example of POSTing with Curl Formatting updates
25 April 2022	Formatting updates
29 January 2023	Added direct WSDL reference Updated sample output for Decimal fields (credit value fields) Updated any reference to HTTP calls to HTTPS
9 March 2023	Added notes about requirement of User-Agent header
6 July 2023	Fixed typos in the `GetCreditsByTimeslotID` example
10 August 2024	Updated to use `api_key` for authentication instead of username/password (which has been deprecated) Added Sona prefix to all function names Added new API functions `SonaGetCreditsByDateRange` and `SonaGetSignupsByDateRange` Updated `APICreditItem` and `APISignup` to include new field occur_date
3 October 2024	Added code examples for various languages.
28 November 2024	Added new API function `SonaCreateUser`
5 January 2025	Updated revision history to add in new API functions that were previously added: `SonaGetPrescreenDataByExperimentID` `SonaGetPrescreenDataByTimeslotID` `SonaSignUpUserToATimeslot` `SonaGrantCreditBySignupID`
13 July 2025	Functions returning `APIPerson` can now return anon_id_code Added new API function: `SonaCreateTimeslot`
27 August 2025	Added new API function: `SonaSetCoursesByPersonID`
6 August 2026	Added new API function: `SonaMergeUser`
19 August 2026	Added `SonaAddUserRole` and `SonaRemoveUserRole` Added `SonaGetStudyCreditAssignmentMismatch` Added payment fields to `APIStudyInfo` and completed its field descriptions Corrected and URL-encoded the sample request URL for `SonaGrantCreditBySignupID` Corrected the documented Boolean result for `SonaGrantCreditBySignupID`
3 September 2026	Added new API function: `SonaSetUserTimeslotUsageLimit`
14 September 2026	Added payment fields and payment status details to `APICreditItem`
15 October 2026	Expanded `WebstudyCredit` documentation with parameters, results, error codes, and examples. Corrected its route and authentication in the OpenAPI specification.
16 October 2026	Corrected request examples, XML responses, and error-code descriptions across the API function reference. Clarified result formats, lookup behavior, and prescreen result limits. Corrected data-class field descriptions. Clarified authentication and JSON POST examples. Expanded the OpenAPI specification to include GET and JSON POST for all documented functions and corrected required parameters.
29 October 2026	Added guidance for downloading documentation files from scripts and AI tools.