POST api/School/UpdateSchool

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Name	string	Required String length: inclusive between 0 and 128
Username	string	Required String length: inclusive between 0 and 128
Password	string	String length: inclusive between 0 and 512
EmailAddress	string	Required String length: inclusive between 0 and 128
Active	boolean	None.
AuthToken	string	None.
LastLoginDate	date	None.
FailedLoginAttempts	integer	None.
IsLocked	boolean	None.
AdminId	integer	None.
Logo	string	None.
PhoneNumber	string	Required String length: inclusive between 0 and 20
ContactName	string	Required String length: inclusive between 0 and 100
Address	string	Required String length: inclusive between 0 and 264
Address2	string	String length: inclusive between 0 and 264
City	string	Required String length: inclusive between 0 and 128
StateCode	string	Required String length: inclusive between 0 and 50
ZipCode	string	Required String length: inclusive between 0 and 10
Error	Error	None.
Introduction	string	Required String length: inclusive between 0 and 5000
NewStudentPassword	string	Required String length: inclusive between 0 and 128
SchoolAssignsGender	boolean	None.
WelcomeSections	Collection of WelcomeSection	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Username": "sample string 3",
  "Password": "sample string 4",
  "EmailAddress": "sample string 5",
  "Active": true,
  "AuthToken": "sample string 7",
  "LastLoginDate": "2025-12-12T08:46:06.194979+00:00",
  "FailedLoginAttempts": 9,
  "IsLocked": true,
  "AdminId": 11,
  "Logo": "sample string 12",
  "PhoneNumber": "sample string 13",
  "ContactName": "sample string 14",
  "Address": "sample string 15",
  "Address2": "sample string 16",
  "City": "sample string 17",
  "StateCode": "sample string 18",
  "ZipCode": "sample string 19",
  "Error": {
    "ID": "sample string 1",
    "RawError": "sample string 2",
    "StackTrace": "sample string 3",
    "FriendlyMessage": "sample string 4"
  },
  "Introduction": "sample string 20",
  "NewStudentPassword": "sample string 21",
  "SchoolAssignsGender": true,
  "WelcomeSections": [
    {
      "Id": 1,
      "SchoolId": 2,
      "SortOrder": 3,
      "Title": "sample string 4",
      "Introduction": "sample string 5",
      "Links": [
        {
          "Id": 1,
          "WelcomeSectionId": 2,
          "Url": "sample string 3",
          "LinkTitle": "sample string 4",
          "SortOrder": 5,
          "SchoolId": 6,
          "AuthToken": "sample string 7",
          "Error": {
            "ID": "sample string 1",
            "RawError": "sample string 2",
            "StackTrace": "sample string 3",
            "FriendlyMessage": "sample string 4"
          }
        },
        {
          "Id": 1,
          "WelcomeSectionId": 2,
          "Url": "sample string 3",
          "LinkTitle": "sample string 4",
          "SortOrder": 5,
          "SchoolId": 6,
          "AuthToken": "sample string 7",
          "Error": {
            "ID": "sample string 1",
            "RawError": "sample string 2",
            "StackTrace": "sample string 3",
            "FriendlyMessage": "sample string 4"
          }
        }
      ],
      "AuthToken": "sample string 6",
      "Image": "sample string 7",
      "Error": {
        "ID": "sample string 1",
        "RawError": "sample string 2",
        "StackTrace": "sample string 3",
        "FriendlyMessage": "sample string 4"
      },
      "LinksTitle": "sample string 8"
    },
    {
      "Id": 1,
      "SchoolId": 2,
      "SortOrder": 3,
      "Title": "sample string 4",
      "Introduction": "sample string 5",
      "Links": [
        {
          "Id": 1,
          "WelcomeSectionId": 2,
          "Url": "sample string 3",
          "LinkTitle": "sample string 4",
          "SortOrder": 5,
          "SchoolId": 6,
          "AuthToken": "sample string 7",
          "Error": {
            "ID": "sample string 1",
            "RawError": "sample string 2",
            "StackTrace": "sample string 3",
            "FriendlyMessage": "sample string 4"
          }
        },
        {
          "Id": 1,
          "WelcomeSectionId": 2,
          "Url": "sample string 3",
          "LinkTitle": "sample string 4",
          "SortOrder": 5,
          "SchoolId": 6,
          "AuthToken": "sample string 7",
          "Error": {
            "ID": "sample string 1",
            "RawError": "sample string 2",
            "StackTrace": "sample string 3",
            "FriendlyMessage": "sample string 4"
          }
        }
      ],
      "AuthToken": "sample string 6",
      "Image": "sample string 7",
      "Error": {
        "ID": "sample string 1",
        "RawError": "sample string 2",
        "StackTrace": "sample string 3",
        "FriendlyMessage": "sample string 4"
      },
      "LinksTitle": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<School xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BSTData">
  <Active>true</Active>
  <Address>sample string 15</Address>
  <Address2>sample string 16</Address2>
  <AdminId>11</AdminId>
  <AuthToken>sample string 7</AuthToken>
  <City>sample string 17</City>
  <ContactName>sample string 14</ContactName>
  <EmailAddress>sample string 5</EmailAddress>
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
    <d2p1:FriendlyMessage>sample string 4</d2p1:FriendlyMessage>
    <d2p1:ID>sample string 1</d2p1:ID>
    <d2p1:RawError>sample string 2</d2p1:RawError>
    <d2p1:StackTrace>sample string 3</d2p1:StackTrace>
  </Error>
  <FailedLoginAttempts>9</FailedLoginAttempts>
  <Id>1</Id>
  <Introduction>sample string 20</Introduction>
  <IsLocked>true</IsLocked>
  <LastLoginDate>2025-12-12T08:46:06.194979+00:00</LastLoginDate>
  <Logo>sample string 12</Logo>
  <Name>sample string 2</Name>
  <NewStudentPassword>sample string 21</NewStudentPassword>
  <Password>sample string 4</Password>
  <PhoneNumber>sample string 13</PhoneNumber>
  <SchoolAssignsGender>true</SchoolAssignsGender>
  <StateCode>sample string 18</StateCode>
  <Username>sample string 3</Username>
  <WelcomeSections>
    <WelcomeSection>
      <AuthToken>sample string 6</AuthToken>
      <Error xmlns:d4p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
        <d4p1:FriendlyMessage>sample string 4</d4p1:FriendlyMessage>
        <d4p1:ID>sample string 1</d4p1:ID>
        <d4p1:RawError>sample string 2</d4p1:RawError>
        <d4p1:StackTrace>sample string 3</d4p1:StackTrace>
      </Error>
      <Id>1</Id>
      <Image>sample string 7</Image>
      <Introduction>sample string 5</Introduction>
      <Links>
        <WelcomeSectionLink>
          <AuthToken>sample string 7</AuthToken>
          <Error xmlns:d6p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
            <d6p1:FriendlyMessage>sample string 4</d6p1:FriendlyMessage>
            <d6p1:ID>sample string 1</d6p1:ID>
            <d6p1:RawError>sample string 2</d6p1:RawError>
            <d6p1:StackTrace>sample string 3</d6p1:StackTrace>
          </Error>
          <Id>1</Id>
          <LinkTitle>sample string 4</LinkTitle>
          <SchoolId>6</SchoolId>
          <SortOrder>5</SortOrder>
          <Url>sample string 3</Url>
          <WelcomeSectionId>2</WelcomeSectionId>
        </WelcomeSectionLink>
        <WelcomeSectionLink>
          <AuthToken>sample string 7</AuthToken>
          <Error xmlns:d6p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
            <d6p1:FriendlyMessage>sample string 4</d6p1:FriendlyMessage>
            <d6p1:ID>sample string 1</d6p1:ID>
            <d6p1:RawError>sample string 2</d6p1:RawError>
            <d6p1:StackTrace>sample string 3</d6p1:StackTrace>
          </Error>
          <Id>1</Id>
          <LinkTitle>sample string 4</LinkTitle>
          <SchoolId>6</SchoolId>
          <SortOrder>5</SortOrder>
          <Url>sample string 3</Url>
          <WelcomeSectionId>2</WelcomeSectionId>
        </WelcomeSectionLink>
      </Links>
      <LinksTitle>sample string 8</LinksTitle>
      <SchoolId>2</SchoolId>
      <SortOrder>3</SortOrder>
      <Title>sample string 4</Title>
    </WelcomeSection>
    <WelcomeSection>
      <AuthToken>sample string 6</AuthToken>
      <Error xmlns:d4p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
        <d4p1:FriendlyMessage>sample string 4</d4p1:FriendlyMessage>
        <d4p1:ID>sample string 1</d4p1:ID>
        <d4p1:RawError>sample string 2</d4p1:RawError>
        <d4p1:StackTrace>sample string 3</d4p1:StackTrace>
      </Error>
      <Id>1</Id>
      <Image>sample string 7</Image>
      <Introduction>sample string 5</Introduction>
      <Links>
        <WelcomeSectionLink>
          <AuthToken>sample string 7</AuthToken>
          <Error xmlns:d6p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
            <d6p1:FriendlyMessage>sample string 4</d6p1:FriendlyMessage>
            <d6p1:ID>sample string 1</d6p1:ID>
            <d6p1:RawError>sample string 2</d6p1:RawError>
            <d6p1:StackTrace>sample string 3</d6p1:StackTrace>
          </Error>
          <Id>1</Id>
          <LinkTitle>sample string 4</LinkTitle>
          <SchoolId>6</SchoolId>
          <SortOrder>5</SortOrder>
          <Url>sample string 3</Url>
          <WelcomeSectionId>2</WelcomeSectionId>
        </WelcomeSectionLink>
        <WelcomeSectionLink>
          <AuthToken>sample string 7</AuthToken>
          <Error xmlns:d6p1="http://schemas.datacontract.org/2004/07/BSTServices.Models">
            <d6p1:FriendlyMessage>sample string 4</d6p1:FriendlyMessage>
            <d6p1:ID>sample string 1</d6p1:ID>
            <d6p1:RawError>sample string 2</d6p1:RawError>
            <d6p1:StackTrace>sample string 3</d6p1:StackTrace>
          </Error>
          <Id>1</Id>
          <LinkTitle>sample string 4</LinkTitle>
          <SchoolId>6</SchoolId>
          <SortOrder>5</SortOrder>
          <Url>sample string 3</Url>
          <WelcomeSectionId>2</WelcomeSectionId>
        </WelcomeSectionLink>
      </Links>
      <LinksTitle>sample string 8</LinksTitle>
      <SchoolId>2</SchoolId>
      <SortOrder>3</SortOrder>
      <Title>sample string 4</Title>
    </WelcomeSection>
  </WelcomeSections>
  <ZipCode>sample string 19</ZipCode>
</School>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.