POST api/mobile/userforgotpassword

Request a user password reset token

Request Information

URI Parameters

None.

Body Parameters

UserForgotPasswordRequest

UserForgotPasswordRequest
NameDescriptionTypeAdditional information
EmailAddress

The email address of the drivers password to change

string

None.

Request Formats

application/json, text/json

Sample:
{
  "EmailAddress": "sample string 1"
}

application/xml, text/xml

Sample:
<UserForgotPasswordRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailAddress>sample string 1</EmailAddress>
</UserForgotPasswordRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

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>