Antel API

ResetPassword

The following routes are available for this service:
POST	/user/password/reset	Reset password for user


export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

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

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public heading: string;

    /** @description Did the intended operation for this response complete successfully? */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

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

export class ResetPasswordResponse extends ApiServiceResponse
{
    public systemUserId: number;

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

export class ResetPassword extends ApiServiceRequest
{
    /** @description Temp password to validate user password change */
    // @ApiMember(Description="Temp password to validate user password change", IsRequired=true)
    public temporaryPassword: string;

    /** @description User email address */
    // @ApiMember(Description="User email address")
    public emailAddress: string;

    /** @description Plain text new user password */
    // @ApiMember(Description="Plain text new user password", IsRequired=true)
    public password: string;

    /** @description Plain text confirmation of new user password */
    // @ApiMember(Description="Plain text confirmation of new user password", IsRequired=true)
    public passwordConfirm: string;

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

TypeScript ResetPassword DTOs

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

HTTP + CSV

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

POST /user/password/reset HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"temporaryPassword":"String","emailAddress":"String","password":"String","passwordConfirm":"String","apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"systemUserId":0,"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}