POST api/forgotpassword

Request Information

URI Parameters

None.

Body Parameters

ForgotPasswordRequest
NameDescriptionTypeAdditional information
emailaddress

string

Required

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<ForgotPasswordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SIPAPI">
  <emailaddress>sample string 1</emailaddress>
</ForgotPasswordRequest>

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

Response Information

Resource Description

GenericMessageResponse
NameDescriptionTypeAdditional information
Status

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<GenericMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SIPAPI">
  <Message>sample string 2</Message>
  <Status>true</Status>
</GenericMessageResponse>