POST api/VerifyUserName

Checks to see if a user name is available.

Request Information

URI Parameters

None.

Body Parameters

VerifyUserNameRequest
NameDescriptionTypeAdditional information
SessionKey

string

Required

UserName

string

Required

Request Formats

application/json, text/json

Sample:
{
  "SessionKey": "sample string 1",
  "UserName": "sample string 2"
}

application/xml, text/xml

Sample:
<VerifyUserNameRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
  <SessionKey>sample string 1</SessionKey>
  <UserName>sample string 2</UserName>
</VerifyUserNameRequest>

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

Response Information

Resource Description

VerifyUserNameResult object

ApiSuccessOfVerifyUserNameResult
NameDescriptionTypeAdditional information
Success

boolean
Data

VerifyUserNameResult

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "UserNameIsAvailable": true
  }
}

application/xml, text/xml

Sample:
<ApiSuccessOfVerifyUserNameResultgLC8bFpX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
    <d2p1:UserNameIsAvailable>true</d2p1:UserNameIsAvailable>
  </Data>
</ApiSuccessOfVerifyUserNameResultgLC8bFpX>