POST api/SchoolPortal/schools/{schoolId}/schooladmins

Request Information

URI Parameters

NameDescriptionTypeAdditional information
schoolId

integer

Required

Body Parameters

SchoolAdminDTO
NameDescriptionTypeAdditional information
Id

integer

None.

UserName

string

None.

Password

string

None.

SchoolId

integer

None.

School

SchoolDTO

None.

Active

boolean

None.

ResetPasswordToken

string

None.

ResetPasswordExpiry

date

None.

ForcePasswordReset

boolean

None.

CreateDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "UserName": "sample string 2",
  "Password": "sample string 3",
  "SchoolId": 4,
  "School": {
    "Id": 1,
    "Name": "sample string 2",
    "Active": true
  },
  "Active": true,
  "ResetPasswordToken": "sample string 6",
  "ResetPasswordExpiry": "2024-11-22T22:32:43.6191017+00:00",
  "ForcePasswordReset": true,
  "CreateDate": "2024-11-22T22:32:43.6191017+00:00"
}

text/html

Sample:
{"Id":1,"UserName":"sample string 2","Password":"sample string 3","SchoolId":4,"School":{"Id":1,"Name":"sample string 2","Active":true},"Active":true,"ResetPasswordToken":"sample string 6","ResetPasswordExpiry":"2024-11-22T22:32:43.6191017+00:00","ForcePasswordReset":true,"CreateDate":"2024-11-22T22:32:43.6191017+00:00"}

application/xml, text/xml

Sample:
<SchoolAdminDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ldl.MessageBroker.DTOs.SchoolPortal">
  <Active>true</Active>
  <CreateDate>2024-11-22T22:32:43.6191017+00:00</CreateDate>
  <ForcePasswordReset>true</ForcePasswordReset>
  <Id>1</Id>
  <Password>sample string 3</Password>
  <ResetPasswordExpiry>2024-11-22T22:32:43.6191017+00:00</ResetPasswordExpiry>
  <ResetPasswordToken>sample string 6</ResetPasswordToken>
  <School>
    <Active>true</Active>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </School>
  <SchoolId>4</SchoolId>
  <UserName>sample string 2</UserName>
</SchoolAdminDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.