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.*


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

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

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

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

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

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

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

open class ResetPasswordResponse : ApiServiceResponse()
{
    var SystemUserId:Int? = null
}

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

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var Heading:String? = 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)
    var WasSuccessful:Boolean? = null

    var ResponseStatus:ResponseStatus? = null
}

Kotlin 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: returnit-api-dev.happen.zone 
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"}}}