Antel Merchandiser App 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 .jsv suffix or ?format=jsv

HTTP + JSV

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: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
		}
	}
}