POST api/CreateUser

Request Information

URI Parameters

None.

Body Parameters

CreateUserVm
NameDescriptionTypeAdditional information
Name

string

None.

Email

string

None.

Username

string

None.

MobileCC

string

None.

Mobile

string

None.

Password

string

None.

Designation

string

None.

RoleId

integer

None.

Subscriptions

Collection of CreateUserSubscriptionVm

None.

Permissions

Collection of CreateUserPermissionVm

None.

TeamIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Email": "sample string 2",
  "Username": "sample string 3",
  "MobileCC": "sample string 4",
  "Mobile": "sample string 5",
  "Password": "sample string 6",
  "Designation": "sample string 7",
  "RoleId": 8,
  "Subscriptions": [
    {
      "SubscriptionMasterId": 1,
      "IsRevoked": true
    },
    {
      "SubscriptionMasterId": 1,
      "IsRevoked": true
    }
  ],
  "Permissions": [
    {
      "Name": "sample string 1",
      "IsRevoked": true
    },
    {
      "Name": "sample string 1",
      "IsRevoked": true
    }
  ],
  "TeamIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<CreateUserVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.User">
  <Designation>sample string 7</Designation>
  <Email>sample string 2</Email>
  <Mobile>sample string 5</Mobile>
  <MobileCC>sample string 4</MobileCC>
  <Name>sample string 1</Name>
  <Password>sample string 6</Password>
  <Permissions>
    <CreateUserPermissionVm>
      <IsRevoked>true</IsRevoked>
      <Name>sample string 1</Name>
    </CreateUserPermissionVm>
    <CreateUserPermissionVm>
      <IsRevoked>true</IsRevoked>
      <Name>sample string 1</Name>
    </CreateUserPermissionVm>
  </Permissions>
  <RoleId>8</RoleId>
  <Subscriptions>
    <CreateUserSubscriptionVm>
      <IsRevoked>true</IsRevoked>
      <SubscriptionMasterId>1</SubscriptionMasterId>
    </CreateUserSubscriptionVm>
    <CreateUserSubscriptionVm>
      <IsRevoked>true</IsRevoked>
      <SubscriptionMasterId>1</SubscriptionMasterId>
    </CreateUserSubscriptionVm>
  </Subscriptions>
  <TeamIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </TeamIds>
  <Username>sample string 3</Username>
</CreateUserVm>

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 'CreateUserVm'.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Description

string

None.

Data

Object

None.

Count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>