SonaFixStudyCreditAssignmentMismatch
Description¶
This function adjusts all cases where there is a credit assignment mismatch. A credit assignment mismatch is a case where a study has course restrictions for a certain set of courses, and the participant (who is in one of those courses) has assigned the credit to another one of their courses that was not in the restriction list. An example would be if a study has course restrictions such that only participants in courses A and B may sign up. A participant who is in courses B and C signs up, and assigns the credit to course C. This situation is entirely normal and usually allowable.
This API call will look for all cases of a mismatch. When it finds one, it will go through that participant’s courses in order based on the course name, and reassign the credit to the first course that is within the course restrictions for the study. If there are no courses to assign the credit to (a rare case), it will un-assign the credit from the current course.
Use SonaGetStudyCreditAssignmentMismatch to review the affected credit assignments before making these changes.
The return value indicates the number of cases where a credit was reassigned or unassigned.
This API call was added for a specific customer, and may not generally be of use in most situations.
Input Parameters¶
Below are the following input parameters for use with the SonaFixStudyCreditAssignmentMismatch API function.
| Parameter | Description / Possible Values |
|---|---|
api_key |
Use API key generated for Sona admin user |
Output Parameters¶
Will return the number of mismatches fixed.
Error Codes¶
Below are the possible error messages encountered and their respective descriptions.
| Error Type | Error Code | Description |
|---|---|---|
| Authentication Failed | -1 through -7 | Standard authentication errors |
Sample Input¶
Request URL
https://myschool.sona-systems.com/services/SonaAPI.svc/SonaFixStudyCreditAssignmentMismatch?api_key=YOUR_API_KEYURL components
| Component | Value |
|---|---|
| Scheme | https |
| Host | myschool.sona-systems.com |
| Service path | /services/SonaAPI.svc |
| Function | SonaFixStudyCreditAssignmentMismatch |
Query parameters
Sample Output¶
<SonaFixStudyCreditAssignmentMismatchResponse
xmlns="https://www.sona-systems.com/"
xmlns:a="http://schemas.datacontract.org/2004/07/emsdotnet.sonasystems"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<SonaFixStudyCreditAssignmentMismatchResult>
<a:Errors i:nil="true" />
<a:Result>4</a:Result>
</SonaFixStudyCreditAssignmentMismatchResult>
</SonaFixStudyCreditAssignmentMismatchResponse>