POST api/UserManager/Create

Create a user

Request Information

URI Parameters

None.

Body Parameters

User's data

UserData
NameDescriptionTypeAdditional information
Name

User name

string

None.

GrantConnection

User has a granted connection

boolean

None.

Id

User's ID

string

None.

FullName

User's Full Name

string

None.

Password

User's password. Used for Create or Edit user.

string

None.

Role

Role name text

string

None.

RoleInt

Role code Viewer (1), Editor (2), Admin (3), Guest (4)

integer

None.

Enable

User is enabled.

boolean

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "grantConnection": true,
  "id": "sample string 3",
  "fullName": "sample string 4",
  "password": "sample string 5",
  "role": "sample string 6",
  "roleInt": 7,
  "enable": true,
  "error": "sample string 9",
  "success": true,
  "errorCode": 11
}

application/xml, text/xml

Sample:
<UserData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>11</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 9</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Enable>true</Enable>
  <FullName>sample string 4</FullName>
  <GrantConnection>true</GrantConnection>
  <Id>sample string 3</Id>
  <Name>sample string 1</Name>
  <Password>sample string 5</Password>
  <Role>sample string 6</Role>
  <RoleInt>7</RoleInt>
</UserData>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserData'.

Response Information

Resource Description

Res
NameDescriptionTypeAdditional information
Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "error": "sample string 1",
  "success": true,
  "errorCode": 3
}

application/xml, text/xml

Sample:
<Res xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>3</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 1</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
</Res>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

data

User data

Property Description
Name (String)
            User name
            
GrantConnection (Boolean)
            User has a granted connection
            
Id (String)
            User's ID
            
FullName (String)
            User's Full Name
            
Password (String)
            User's password. Used for Create or Edit user.
            
Role (String)
            Role name text
            
RoleInt (Int32)
             Role code Viewer (1), Editor (2), Admin (3), Guest (4)
            
Enable (Boolean)
            User is enabled.
            
Error (String)
            Error description if the operation failed
            
Success (Boolean)
            Operation result
            
ErrorCode (Int32)
             Error code
            
}