PATCH api/MyAccount/ForgotPassword?expand={expand}

Module : My Account; BE JIRA: ADINA-6326; This method is calling for reset password of user before logged in to system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
expand

string

Required

Body Parameters

ForgotPasswordEntity
NameDescriptionTypeAdditional information
securityQuestion

string

None.

answer

string

None.

password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "securityQuestion": "sample string 1",
  "answer": "sample string 2",
  "password": "sample string 3"
}

application/xml, text/xml

Sample:
<ForgotPasswordEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <answer>sample string 2</answer>
  <password>sample string 3</password>
  <securityQuestion>sample string 1</securityQuestion>
</ForgotPasswordEntity>

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

Response Information

Resource Description

BaseBusinessEntity
NameDescriptionTypeAdditional information
Message

string

None.

WebApiIsSuccess

boolean

None.

WebApiResponseMessage

string

None.

WebApiErrorCode

string

None.

error_description

string

None.

CookieData

Collection of AppCookie

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "WebApiIsSuccess": true,
  "WebApiResponseMessage": "sample string 3",
  "WebApiErrorCode": "sample string 4",
  "error_description": "sample string 5",
  "CookieData": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<BaseBusinessEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <CookieData>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
  </CookieData>
  <Message>sample string 1</Message>
  <WebApiErrorCode>sample string 4</WebApiErrorCode>
  <WebApiIsSuccess>true</WebApiIsSuccess>
  <WebApiResponseMessage>sample string 3</WebApiResponseMessage>
  <error_description>sample string 5</error_description>
</BaseBusinessEntity>