POST api/Customers/HandleForgotPassword

Receove request to get forgot Password

Request Information

URI Parameters

None.

Body Parameters

ForgotPasswordRequest
NameDescriptionTypeAdditional information
Email

string

None.

UserName

The provided user name.

string

Required

Salt

A random number(at least 9 digits)

integer

Required

Digest

A digest of the user credentials and the request

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Email": "sample string 1",
  "UserName": "sample string 2",
  "Salt": 3,
  "Digest": "sample string 4"
}

application/xml, text/xml

Sample:
<ForgotPasswordRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="sample string 2" Salt="3" Digest="sample string 4" Email="sample string 1" />

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

returns Forgot Password object

ForgotPasswordResponse
NameDescriptionTypeAdditional information
UserName

string

None.

Email

string

None.

Password

string

None.

Success

Indicate if the operation was success

boolean

None.

Message

Return of errors or indicated return message/data

string

None.

Extra1

Additional info 1 to return

string

None.

Extra2

Additional info 2 to return

string

None.

Extra3

Additional info 3 to return

string

None.

Response Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Email": "sample string 2",
  "Password": "sample string 3",
  "Success": true,
  "Message": "sample string 5",
  "Extra1": "sample string 6",
  "Extra2": "sample string 7",
  "Extra3": "sample string 8"
}

application/xml, text/xml

Sample:
<ForgotPasswordResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <Message>sample string 5</Message>
  <Extra1>sample string 6</Extra1>
  <Extra2>sample string 7</Extra2>
  <Extra3>sample string 8</Extra3>
  <UserName>sample string 1</UserName>
  <Email>sample string 2</Email>
  <Password>sample string 3</Password>
</ForgotPasswordResponse>