POST api/User/RegisterNewUser

Request Information

URI Parameters

None.

Body Parameters

UserModel
NameDescriptionTypeAdditional information
UserID

integer

None.

SiteID

integer

None.

Active

integer

None.

UserName

string

None.

UserGroupIDs

Collection of integer

None.

FirstName

string

None.

LastName

string

None.

Phone

string

None.

Email

string

None.

CustomFieldValues

Dictionary of integer [key] and string [value]

None.

ApproveNewsLetter

boolean

None.

MemberClubPoints

decimal number

None.

ExternalID

string

None.

Message

string

None.

Success

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "SiteID": 2,
  "Active": 3,
  "UserName": "sample string 4",
  "UserGroupIDs": [
    1,
    2
  ],
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "Phone": "sample string 7",
  "Email": "sample string 8",
  "CustomFieldValues": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "ApproveNewsLetter": true,
  "MemberClubPoints": 10.1,
  "ExternalID": "sample string 11",
  "Message": "sample string 12",
  "Success": true
}

text/xml

Sample:
<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MoodAPI.Models">
  <Message>sample string 12</Message>
  <Success>true</Success>
  <Active>3</Active>
  <ApproveNewsLetter>true</ApproveNewsLetter>
  <CustomFieldValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </CustomFieldValues>
  <Email>sample string 8</Email>
  <ExternalID>sample string 11</ExternalID>
  <FirstName>sample string 5</FirstName>
  <LastName>sample string 6</LastName>
  <MemberClubPoints>10.1</MemberClubPoints>
  <Phone>sample string 7</Phone>
  <SiteID>2</SiteID>
  <UserGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </UserGroupIDs>
  <UserID>1</UserID>
  <UserName>sample string 4</UserName>
</UserModel>

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

Response Information

Resource Description

UserModel
NameDescriptionTypeAdditional information
UserID

integer

None.

SiteID

integer

None.

Active

integer

None.

UserName

string

None.

UserGroupIDs

Collection of integer

None.

FirstName

string

None.

LastName

string

None.

Phone

string

None.

Email

string

None.

CustomFieldValues

Dictionary of integer [key] and string [value]

None.

ApproveNewsLetter

boolean

None.

MemberClubPoints

decimal number

None.

ExternalID

string

None.

Message

string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "SiteID": 2,
  "Active": 3,
  "UserName": "sample string 4",
  "UserGroupIDs": [
    1,
    2
  ],
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "Phone": "sample string 7",
  "Email": "sample string 8",
  "CustomFieldValues": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "ApproveNewsLetter": true,
  "MemberClubPoints": 10.1,
  "ExternalID": "sample string 11",
  "Message": "sample string 12",
  "Success": true
}

text/xml

Sample:
<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MoodAPI.Models">
  <Message>sample string 12</Message>
  <Success>true</Success>
  <Active>3</Active>
  <ApproveNewsLetter>true</ApproveNewsLetter>
  <CustomFieldValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </CustomFieldValues>
  <Email>sample string 8</Email>
  <ExternalID>sample string 11</ExternalID>
  <FirstName>sample string 5</FirstName>
  <LastName>sample string 6</LastName>
  <MemberClubPoints>10.1</MemberClubPoints>
  <Phone>sample string 7</Phone>
  <SiteID>2</SiteID>
  <UserGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </UserGroupIDs>
  <UserID>1</UserID>
  <UserName>sample string 4</UserName>
</UserModel>