POST api/Accounts?createUserId={createUserId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
createUserId

string

Required

Body Parameters

RegisterBindingModel
NameDescriptionTypeAdditional information
Id

string

None.

UserName

string

None.

Password

string

Data type: Password

Matching regular expression pattern: ^(?=.*[A-Za-z])(?=.*\d).{6,}$

String length: inclusive between 6 and 100

ConfirmPassword

string

Data type: Password

Email

string

Matching regular expression pattern: ^([\w\.\-']+)@([\w\.\-]+)((\.(\w){2,3})+)$

Honorific

string

None.

FirstName

string

Required

LastName

string

None.

NickName

string

None.

StateId

integer

None.

UserRole

string

None.

PhoneNumber

string

None.

Avatar

string

None.

StandardTypeId

integer

None.

GradeLevelId

integer

None.

PrimarySubjectId

integer

None.

SurveyReferralTypeId

integer

None.

StudentId

string

None.

ForcePasswordChange

boolean

None.

GoogleId

string

None.

SchoologyId

string

None.

SchoologyAccess

string

None.

SchoologyUserName

string

None.

isThroughAccountAdmin

To check whether the user has been registered through Account Admin feature

boolean

None.

accountId

integer

None.

errorId

integer

None.

hasTeacherStudentLink

boolean

None.

isAccountAdmin

boolean

None.

createdOn

date

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "userName": "sample string 2",
  "password": "sample string 3",
  "confirmPassword": "sample string 4",
  "email": "sample string 5",
  "honorific": "sample string 6",
  "firstName": "sample string 7",
  "lastName": "sample string 8",
  "nickName": "sample string 9",
  "stateId": 1,
  "userRole": "sample string 10",
  "phoneNumber": "sample string 11",
  "avatar": "sample string 12",
  "standardTypeId": 1,
  "gradeLevelId": 1,
  "primarySubjectId": 1,
  "surveyReferralTypeId": 1,
  "studentId": "sample string 13",
  "forcePasswordChange": true,
  "googleId": "sample string 14",
  "schoologyId": "sample string 15",
  "schoologyAccess": "sample string 16",
  "schoologyUserName": "sample string 17",
  "isThroughAccountAdmin": true,
  "accountId": 1,
  "errorId": 1,
  "hasTeacherStudentLink": true,
  "isAccountAdmin": true,
  "createdOn": "2022-08-12T09:49:20.2955059Z"
}

application/xml, text/xml

Sample:
<RegisterBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OHS.TLMClassroomResponder.WebAPI.Models">
  <Avatar>sample string 12</Avatar>
  <ConfirmPassword>sample string 4</ConfirmPassword>
  <Email>sample string 5</Email>
  <FirstName>sample string 7</FirstName>
  <ForcePasswordChange>true</ForcePasswordChange>
  <GoogleId>sample string 14</GoogleId>
  <GradeLevelId>1</GradeLevelId>
  <Honorific>sample string 6</Honorific>
  <Id>sample string 1</Id>
  <LastName>sample string 8</LastName>
  <NickName>sample string 9</NickName>
  <Password>sample string 3</Password>
  <PhoneNumber>sample string 11</PhoneNumber>
  <PrimarySubjectId>1</PrimarySubjectId>
  <SchoologyAccess>sample string 16</SchoologyAccess>
  <SchoologyId>sample string 15</SchoologyId>
  <SchoologyUserName>sample string 17</SchoologyUserName>
  <StandardTypeId>1</StandardTypeId>
  <StateId>1</StateId>
  <StudentId>sample string 13</StudentId>
  <SurveyReferralTypeId>1</SurveyReferralTypeId>
  <UserName>sample string 2</UserName>
  <UserRole>sample string 10</UserRole>
  <accountId>1</accountId>
  <createdOn>2022-08-12T05:49:20.2955059-04:00</createdOn>
  <errorId>1</errorId>
  <hasTeacherStudentLink>true</hasTeacherStudentLink>
  <isAccountAdmin>true</isAccountAdmin>
  <isThroughAccountAdmin>true</isThroughAccountAdmin>
</RegisterBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>