Antel API

<back to all web services

ResetPassword

The following routes are available for this service:
POST/user/password/resetReset password for user
import 'package:servicestack/servicestack.dart';

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

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

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

    ApiServiceRequest({this.apiKey,this.latitude,this.longitude});
    ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiKey = json['apiKey'];
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiKey': apiKey,
        'latitude': latitude,
        'longitude': longitude
    };

    getTypeName() => "ApiServiceRequest";
    TypeContext? context = _ctx;
}

class ApiServiceResponse implements IServiceResponse, IConvertible
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    String? description;

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    String? heading;

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

    ResponseStatus? responseStatus;

    ApiServiceResponse({this.description,this.heading,this.wasSuccessful,this.responseStatus});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        description = json['description'];
        heading = json['heading'];
        wasSuccessful = json['wasSuccessful'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'description': description,
        'heading': heading,
        'wasSuccessful': wasSuccessful,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ApiServiceResponse";
    TypeContext? context = _ctx;
}

class ResetPasswordResponse extends ApiServiceResponse implements IConvertible
{
    int? systemUserId;

    ResetPasswordResponse({this.systemUserId});
    ResetPasswordResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        systemUserId = json['systemUserId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'systemUserId': systemUserId
    });

    getTypeName() => "ResetPasswordResponse";
    TypeContext? context = _ctx;
}

class ResetPassword extends ApiServiceRequest implements IConvertible
{
    /**
    * Temp password to validate user password change
    */
    // @ApiMember(Description="Temp password to validate user password change", IsRequired=true)
    String? temporaryPassword;

    /**
    * User email address
    */
    // @ApiMember(Description="User email address")
    String? emailAddress;

    /**
    * Plain text new user password
    */
    // @ApiMember(Description="Plain text new user password", IsRequired=true)
    String? password;

    /**
    * Plain text confirmation of new user password
    */
    // @ApiMember(Description="Plain text confirmation of new user password", IsRequired=true)
    String? passwordConfirm;

    ResetPassword({this.temporaryPassword,this.emailAddress,this.password,this.passwordConfirm});
    ResetPassword.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        temporaryPassword = json['temporaryPassword'];
        emailAddress = json['emailAddress'];
        password = json['password'];
        passwordConfirm = json['passwordConfirm'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'temporaryPassword': temporaryPassword,
        'emailAddress': emailAddress,
        'password': password,
        'passwordConfirm': passwordConfirm
    });

    getTypeName() => "ResetPassword";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'antel.api.dev.86degrees.com', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'ResetPasswordResponse': TypeInfo(TypeOf.Class, create:() => ResetPasswordResponse()),
    'ResetPassword': TypeInfo(TypeOf.Class, create:() => ResetPassword()),
});

Dart 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"}}}