PUT api/Users/{userId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

string

Required

Body Parameters

UserEntity
NameDescriptionTypeAdditional information
id

string

None.

userName

string

None.

honorific

string

None.

firstName

string

None.

lastName

string

None.

email

string

None.

stateId

integer

None.

userRole

string

None.

lastLogin

date

None.

phoneNumber

string

None.

gradeLevelId

integer

None.

studentId

string

None.

standardTypeId

integer

None.

avatar

string

None.

hideNavigationWarning

boolean

None.

tempEmail

string

None.

forcePasswordChange

boolean

None.

accountDisabled

boolean

None.

hasClassLibrary

boolean

None.

disabledReason

string

None.

googleEmail

string

None.

googleId

string

None.

schoologyId

string

None.

schoologyUsername

string

None.

edinsightProviderId

integer

None.

edinsightUserId

integer

None.

gradeLevelDesc

string

None.

noOfLinkedStudents

integer

None.

primarySubjectId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "userName": "sample string 2",
  "honorific": "sample string 3",
  "firstName": "sample string 4",
  "lastName": "sample string 5",
  "email": "sample string 6",
  "stateId": 1,
  "userRole": "sample string 7",
  "lastLogin": "2022-08-12T09:06:16.7907503Z",
  "phoneNumber": "sample string 8",
  "gradeLevelId": 1,
  "studentId": "sample string 9",
  "standardTypeId": 1,
  "avatar": "sample string 10",
  "hideNavigationWarning": true,
  "tempEmail": "sample string 12",
  "forcePasswordChange": true,
  "accountDisabled": true,
  "hasClassLibrary": true,
  "disabledReason": "sample string 13",
  "googleEmail": "sample string 14",
  "googleId": "sample string 15",
  "schoologyId": "sample string 16",
  "schoologyUsername": "sample string 17",
  "edinsightProviderId": 1,
  "edinsightUserId": 1,
  "gradeLevelDesc": "sample string 18",
  "noOfLinkedStudents": 1,
  "primarySubjectId": 1
}

application/xml, text/xml

Sample:
<UserEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OHS.TLMClassroomResponder.BusinessEntity">
  <accountDisabled>true</accountDisabled>
  <avatar>sample string 10</avatar>
  <disabledReason>sample string 13</disabledReason>
  <edinsightProviderId>1</edinsightProviderId>
  <edinsightUserId>1</edinsightUserId>
  <email>sample string 6</email>
  <firstName>sample string 4</firstName>
  <forcePasswordChange>true</forcePasswordChange>
  <googleEmail>sample string 14</googleEmail>
  <googleId>sample string 15</googleId>
  <gradeLevelDesc>sample string 18</gradeLevelDesc>
  <gradeLevelId>1</gradeLevelId>
  <hasClassLibrary>true</hasClassLibrary>
  <hideNavigationWarning>true</hideNavigationWarning>
  <honorific>sample string 3</honorific>
  <id>sample string 1</id>
  <lastLogin>2022-08-12T05:06:16.7907503-04:00</lastLogin>
  <lastName>sample string 5</lastName>
  <noOfLinkedStudents>1</noOfLinkedStudents>
  <phoneNumber>sample string 8</phoneNumber>
  <primarySubjectId>1</primarySubjectId>
  <schoologyId>sample string 16</schoologyId>
  <schoologyUsername>sample string 17</schoologyUsername>
  <standardTypeId>1</standardTypeId>
  <stateId>1</stateId>
  <studentId>sample string 9</studentId>
  <tempEmail>sample string 12</tempEmail>
  <userName>sample string 2</userName>
  <userRole>sample string 7</userRole>
</UserEntity>

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.