POST api/User/UpdateUser

Used for updating the user details and get the roles of the user

Request Information

URI Parameters

None.

Body Parameters

User object which contains the details of the user to update

User
NameDescriptionTypeAdditional information
UserId

UserId, which holds the primary key of the User table

integer

None.

EmailAddress

Emailaddress of the admin user

string

None.

FirstName

FirstName of the admin user

string

None.

LastName

LastName of the admin user

string

None.

Office365ReferenceId

Office 365 reference of the user who logged in

string

None.

IsAllowedToLogin

Flag which confirm whether user can login or not

boolean

None.

LstUserRole

List, which contains the roles available for the user

Collection of UserRole

None.

Request Formats

application/json, text/json

Sample:
{
  "userId": 1,
  "emailAddress": "sample string 2",
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "office365ReferenceId": "sample string 5",
  "isAllowedToLogin": true,
  "lstUserRole": [
    {
      "userId": 1,
      "roleCode": "sample string 2",
      "roleName": "sample string 3"
    },
    {
      "userId": 1,
      "roleCode": "sample string 2",
      "roleName": "sample string 3"
    }
  ]
}

text/html

Sample:
{"userId":1,"emailAddress":"sample string 2","firstName":"sample string 3","lastName":"sample string 4","office365ReferenceId":"sample string 5","isAllowedToLogin":true,"lstUserRole":[{"userId":1,"roleCode":"sample string 2","roleName":"sample string 3"},{"userId":1,"roleCode":"sample string 2","roleName":"sample string 3"}]}

application/xml, text/xml

Sample:
<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CapApi.Models">
  <EmailAddress>sample string 2</EmailAddress>
  <FirstName>sample string 3</FirstName>
  <IsAllowedToLogin>true</IsAllowedToLogin>
  <LastName>sample string 4</LastName>
  <LstUserRole>
    <UserRole>
      <RoleCode>sample string 2</RoleCode>
      <RoleName>sample string 3</RoleName>
      <UserId>1</UserId>
    </UserRole>
    <UserRole>
      <RoleCode>sample string 2</RoleCode>
      <RoleName>sample string 3</RoleName>
      <UserId>1</UserId>
    </UserRole>
  </LstUserRole>
  <Office365ReferenceId>sample string 5</Office365ReferenceId>
  <UserId>1</UserId>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.