POST students/{userIdentifier}/goals/{goalId}
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
- Authenticated user who is either StaffMember
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userIdentifier | PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier |
Required |
|
| goalId | globally unique identifier |
Required |
Body Parameters
PearsonEnglish.LearningServices.Core.Models.Views.StudentGoalViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| GoalType | PearsonEnglish.LearningServices.Core.Models.Enums.StudentGoalTypes |
None. |
|
| Title | string |
None. |
|
| Reason | string |
None. |
|
| Notes | string |
None. |
|
| Deadline | date |
None. |
|
| LevelNumber | integer |
None. |
|
| GseScore | decimal number |
None. |
|
| HoursCount | integer |
None. |
|
| TimesCount | integer |
None. |
|
| MonthsCount | integer |
None. |
|
| ScoreTestType | PearsonEnglish.LearningServices.Core.Models.Enums.StudentGoalTestTypes |
None. |
|
| PassTestType | PearsonEnglish.LearningServices.Core.Models.Enums.StudentGoalTestTypes |
None. |
|
| TestScore | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{
"GoalType": 0,
"Title": "sample string 1",
"Reason": "sample string 2",
"Notes": "sample string 3",
"Deadline": "2024-12-20T14:22:54.1770365+00:00",
"LevelNumber": 1,
"GseScore": 1.1,
"HoursCount": 1,
"TimesCount": 1,
"MonthsCount": 1,
"ScoreTestType": 1,
"PassTestType": 1,
"TestScore": 1.1
}
Response Information
Resource Description
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.