PUT api/account

V1 - Confirms the validity of a users emailaddress using the pregenerated confirmation token.

Request Information

URI Parameters

None.

Body Parameters

UserConfirmation
NameDescriptionTypeAdditional information
UserID

The UserID is for the account that needs to be confirmed.

globally unique identifier

Required

ConfirmationCode

The confirmationcode which was supplied at registration.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "UserID": "49cf0791-cbb9-4a10-9c14-9919fd04e9bd",
  "ConfirmationCode": "sample string 2"
}

text/javascript

Sample:
{"UserID":"49cf0791-cbb9-4a10-9c14-9919fd04e9bd","ConfirmationCode":"sample string 2"}

application/xml, text/xml

Sample:
<UserConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VersionedVendorApi.Models">
  <ConfirmationCode>sample string 2</ConfirmationCode>
  <UserID>49cf0791-cbb9-4a10-9c14-9919fd04e9bd</UserID>
</UserConfirmation>

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

Response Information

Resource Description

RegistrationResult
NameDescriptionTypeAdditional information
UserID

The UserID is created when the registration is completed.

string

None.

Email

The registered email address.

string

Data type: EmailAddress

Username

The registered username.

string

Data type: Text

ConfirmationCode

A generated code that needs to be provided to confirm the newly created user account.

string

Data type: Text

Status

YindoApiStatus defines statuscodes.

YindoApiStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "UserID": "sample string 1",
  "Email": "sample string 2",
  "Username": "sample string 3",
  "ConfirmationCode": "sample string 4",
  "Status": {
    "Code": 0,
    "Text": "sample string 1"
  }
}

text/javascript

Sample:
{"UserID":"sample string 1","Email":"sample string 2","Username":"sample string 3","ConfirmationCode":"sample string 4","Status":{"Code":0,"Text":"sample string 1"}}

application/xml, text/xml

Sample:
<RegistrationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VersionedVendorApi.Models">
  <Status xmlns="http://schemas.datacontract.org/2004/07/Yindo.BLL.API">
    <Code>Success</Code>
    <Text>sample string 1</Text>
  </Status>
  <ConfirmationCode>sample string 4</ConfirmationCode>
  <Email>sample string 2</Email>
  <UserID>sample string 1</UserID>
  <Username>sample string 3</Username>
</RegistrationResult>