GET api/mobile/userforgotpassword/{userName}

Request a user password reset token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userName

The username (email address) of the user to have a password reset

string

Required

Body Parameters

None.

Response Information

Resource Description

UserForgotPasswordResponse

UserForgotPasswordResponse
NameDescriptionTypeAdditional information
Result

Indicates if the request was successful

boolean

None.

ErrorCode

Identifies any possible errors

WebserviceErrorCode

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": true,
  "ErrorCode": 0
}

application/xml, text/xml

Sample:
<UserForgotPasswordResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>true</Result>
  <ErrorCode>None</ErrorCode>
</UserForgotPasswordResponse>