Antel API

<back to all web services

ResetPassword

The following routes are available for this service:
POST/user/password/resetReset password for user
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

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

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

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

        /**
        * Plain text confirmation of new user password
        */
        @ApiMember(Description="Plain text confirmation of new user password", IsRequired=true)
        public String passwordConfirm = null;
        
        public String getTemporaryPassword() { return temporaryPassword; }
        public ResetPassword setTemporaryPassword(String value) { this.temporaryPassword = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public ResetPassword setEmailAddress(String value) { this.emailAddress = value; return this; }
        public String getPassword() { return password; }
        public ResetPassword setPassword(String value) { this.password = value; return this; }
        public String getPasswordConfirm() { return passwordConfirm; }
        public ResetPassword setPasswordConfirm(String value) { this.passwordConfirm = value; return this; }
    }

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

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

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class ResetPasswordResponse extends ApiServiceResponse
    {
        public Integer systemUserId = null;
        
        public Integer getSystemUserId() { return systemUserId; }
        public ResetPasswordResponse setSystemUserId(Integer value) { this.systemUserId = value; return this; }
    }

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

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

        /**
        * 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 Boolean wasSuccessful = null;

        public ResponseStatus responseStatus = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

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