POST API/Account/ForgotPassword

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserName	string	None.
Email	string	None.
ApiKey	string	None.
apiKey	string	None.
UserId	string	None.
IPAddress	string	None.
ApplicationId	string	None.
VersionId	string	None.
ClientConfigVersion	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "userName": "sample string 1",
  "email": "sample string 2",
  "apiKey": "sample string 3",
  "userId": "sample string 5",
  "ipAddress": "sample string 6",
  "applicationId": "sample string 7",
  "versionId": "sample string 8",
  "clientConfigVersion": 9
}

application/xml, text/xml

Sample:

<ForgotPasswordRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Areas.Account.Models">
  <ApplicationId xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">sample string 7</ApplicationId>
  <ClientConfigVersion xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">9</ClientConfigVersion>
  <IPAddress xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">sample string 6</IPAddress>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">sample string 5</UserId>
  <VersionId xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">sample string 8</VersionId>
  <apiKey>sample string 4</apiKey>
  <ApiKey>sample string 3</ApiKey>
  <Email>sample string 2</Email>
  <UserName>sample string 1</UserName>
</ForgotPasswordRequestViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ForgotPasswordResponseViewModel

Name	Type	Additional information
Status	ForgotPasswordStatus	None.
Errors	Collection of ServiceErrorViewModel	None.
Status	ResponseStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "errors": [
    {
      "level": 1,
      "errorDescription": "sample string 1",
      "stackTrace": "sample string 2",
      "error": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    },
    {
      "level": 1,
      "errorDescription": "sample string 1",
      "stackTrace": "sample string 2",
      "error": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ForgotPasswordResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Areas.Account.Models">
  <Errors xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">
    <ServiceErrorViewModel>
      <Error xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <ClassName xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string" xmlns="">System.Exception</ClassName>
        <Message i:nil="true" xmlns="" />
        <Data i:nil="true" xmlns="" />
        <InnerException i:nil="true" xmlns="" />
        <HelpURL xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string" xmlns="">sample string 1</HelpURL>
        <StackTraceString i:nil="true" xmlns="" />
        <RemoteStackTraceString i:nil="true" xmlns="" />
        <RemoteStackIndex xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int" xmlns="">0</RemoteStackIndex>
        <ExceptionMethod i:nil="true" xmlns="" />
        <HResult xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int" xmlns="">3</HResult>
        <Source xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string" xmlns="">sample string 2</Source>
        <WatsonBuckets i:nil="true" xmlns="" />
      </Error>
      <ErrorDescription>sample string 1</ErrorDescription>
      <Level>Critical</Level>
      <StackTrace>sample string 2</StackTrace>
    </ServiceErrorViewModel>
    <ServiceErrorViewModel>
      <Error xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <ClassName xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string" xmlns="">System.Exception</ClassName>
        <Message i:nil="true" xmlns="" />
        <Data i:nil="true" xmlns="" />
        <InnerException i:nil="true" xmlns="" />
        <HelpURL xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string" xmlns="">sample string 1</HelpURL>
        <StackTraceString i:nil="true" xmlns="" />
        <RemoteStackTraceString i:nil="true" xmlns="" />
        <RemoteStackIndex xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int" xmlns="">0</RemoteStackIndex>
        <ExceptionMethod i:nil="true" xmlns="" />
        <HResult xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:int" xmlns="">3</HResult>
        <Source xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string" xmlns="">sample string 2</Source>
        <WatsonBuckets i:nil="true" xmlns="" />
      </Error>
      <ErrorDescription>sample string 1</ErrorDescription>
      <Level>Critical</Level>
      <StackTrace>sample string 2</StackTrace>
    </ServiceErrorViewModel>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/ARIES.Alacrity.Services.Models">Success</Status>
  <Status>Success</Status>
</ForgotPasswordResponseViewModel>