Antel Merchandiser App API

<back to all web services

ResetPassword

import Foundation
import ServiceStack

public class ResetPassword : ApiServiceRequest
{
    /**
    * Temp password to validate user password change
    */
    // @ApiMember(Description="Temp password to validate user password change", IsRequired=true)
    public var temporaryPassword:String?

    /**
    * User email address
    */
    // @ApiMember(Description="User email address")
    public var emailAddress:String?

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case temporaryPassword
        case emailAddress
        case password
        case passwordConfirm
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        temporaryPassword = try container.decodeIfPresent(String.self, forKey: .temporaryPassword)
        emailAddress = try container.decodeIfPresent(String.self, forKey: .emailAddress)
        password = try container.decodeIfPresent(String.self, forKey: .password)
        passwordConfirm = try container.decodeIfPresent(String.self, forKey: .passwordConfirm)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if temporaryPassword != nil { try container.encode(temporaryPassword, forKey: .temporaryPassword) }
        if emailAddress != nil { try container.encode(emailAddress, forKey: .emailAddress) }
        if password != nil { try container.encode(password, forKey: .password) }
        if passwordConfirm != nil { try container.encode(passwordConfirm, forKey: .passwordConfirm) }
    }
}

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

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

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

    required public init(){}
}

public class ResetPasswordResponse : ApiServiceResponse
{
    public var systemUserId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case systemUserId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        systemUserId = try container.decodeIfPresent(Int.self, forKey: .systemUserId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if systemUserId != nil { try container.encode(systemUserId, forKey: .systemUserId) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public var Description:String?

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

    /**
    * 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 var wasSuccessful:Bool?

    public var responseStatus:ResponseStatus?

    required public init(){}
}

Swift ResetPassword DTOs

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