POST api/students

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Email	string	Matching regular expression pattern: ^([\w\.\-']+)@([\w\.\-]+)((\.(\w){2,3})+)$
GradeLevelId	integer	Required
StudentId	string	None.
Username	string	Required
Password	string	Required Data type: Password Matching regular expression pattern: ^(?=.[A-Za-z])(?=.\d).{6,}$ String length: inclusive between 6 and 100
ConfirmPassword	string	Required Data type: Password
FirstName	string	Required
LastName	string	Required
ForcePasswordChange	boolean	None.
IsThroughAccountAdmin	boolean	None.
AccountId	integer	None.
ErrorId	integer	None.
HasTeacherStudentLink	boolean	None.
IsAccountAdmin	boolean	None.
CreatedOn	date	None.

Request Formats

application/json, text/json

Sample:

{
  "email": "sample string 1",
  "gradeLevelId": 1,
  "studentId": "sample string 2",
  "username": "sample string 3",
  "password": "sample string 4",
  "confirmPassword": "sample string 5",
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "forcePasswordChange": true,
  "isThroughAccountAdmin": true,
  "accountId": 1,
  "errorId": 1,
  "hasTeacherStudentLink": true,
  "isAccountAdmin": true,
  "createdOn": "2024-11-20T17:21:30.0086338Z"
}

application/xml, text/xml

Sample:

<StudentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OHS.TLMClassroomResponder.WebAPI.Models.ViewModels">
  <AccountId>1</AccountId>
  <ConfirmPassword>sample string 5</ConfirmPassword>
  <CreatedOn>2024-11-20T12:21:30.0086338-05:00</CreatedOn>
  <ErrorId>1</ErrorId>
  <FirstName>sample string 6</FirstName>
  <ForcePasswordChange>true</ForcePasswordChange>
  <HasTeacherStudentLink>true</HasTeacherStudentLink>
  <IsAccountAdmin>true</IsAccountAdmin>
  <IsThroughAccountAdmin>true</IsThroughAccountAdmin>
  <LastName>sample string 7</LastName>
  <Password>sample string 4</Password>
  <Email>sample string 1</Email>
  <GradeLevelId>1</GradeLevelId>
  <StudentId>sample string 2</StudentId>
  <Username>sample string 3</Username>
</StudentViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.