Platform API

GetResetPasswordToken

Generate password reset token and send email

The following routes are available for this service:
All Verbs	/api/account/{UserName}/passwordresettoken


/** @description Generate password reset token and send email */
// @Api(Description="Generate password reset token and send email")
export class GetResetPasswordToken implements IPublicServiceModel
{
    /** @description Get password reset token for the specified user name */
    // @ApiMember(Description="Get password reset token for the specified user name", Name="UserName")
    public UserName: string;

    public ApplianceId: string;
    public SubdomainName: string;
    public SuiteId: string;
    /** @description Appliance Url for the appliance */
    // @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
    public ApplianceLoginUrl: string;

    public constructor(init?: Partial<GetResetPasswordToken>) { (Object as any).assign(this, init); }
}

export class GetResetPasswordTokenResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetResetPasswordTokenResponse>) { (Object as any).assign(this, init); }
}

TypeScript GetResetPasswordToken DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/account/{UserName}/passwordresettoken HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetResetPasswordToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
  <ApplianceLoginUrl>String</ApplianceLoginUrl>
  <SubdomainName>String</SubdomainName>
  <SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
  <UserName>String</UserName>
</GetResetPasswordToken>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetResetPasswordTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetResetPasswordTokenResponse>