Antel 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: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ResetPassword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <EmailAddress>String</EmailAddress>
  <Password>String</Password>
  <PasswordConfirm>String</PasswordConfirm>
  <TemporaryPassword>String</TemporaryPassword>
</ResetPassword>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResetPasswordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <SystemUserId>0</SystemUserId>
</ResetPasswordResponse>