Insure Guard App API

<back to all web services

ConfirmOtp

import Foundation
import ServiceStack

public class ConfirmOtp : ApiServiceRequest
{
    public var systemUserId:Int
    public var otp:String
    public var utcOffset:Int
    /**
    * The user's push token - used for push messages.
    */
    // @ApiMember(Description="The user's push token - used for push messages.")
    public var pushPlayerId:String

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

    private enum CodingKeys : String, CodingKey {
        case systemUserId
        case otp
        case utcOffset
        case pushPlayerId
    }

    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)
        otp = try container.decodeIfPresent(String.self, forKey: .otp)
        utcOffset = try container.decodeIfPresent(Int.self, forKey: .utcOffset)
        pushPlayerId = try container.decodeIfPresent(String.self, forKey: .pushPlayerId)
    }

    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) }
        if otp != nil { try container.encode(otp, forKey: .otp) }
        if utcOffset != nil { try container.encode(utcOffset, forKey: .utcOffset) }
        if pushPlayerId != nil { try container.encode(pushPlayerId, forKey: .pushPlayerId) }
    }
}

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 ConfirmOtpResponse : ApiServiceResponse
{
    public var data:LoginData

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

    private enum CodingKeys : String, CodingKey {
        case data
    }

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

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

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(){}
}

public class LoginData : Codable
{
    public var systemUserId:Int
    public var refreshToken:String
    public var hasActivePanicCover:Bool
    public var accountInArrears:Bool
    public var updateClientInformation:Bool
    public var nextPanicDate:String
    public var panicReference:String
    public var clientData:ClientData

    required public init(){}
}

public class ClientData : Codable
{
    public var firstName:String
    public var surname:String
    public var email:String
    public var mobileNumber:String
    public var address1:String
    public var address2:String
    public var city:String
    public var dateOfBirth:String
    public var sourceOfIncome:String

    required public init(){}
}


Swift ConfirmOtp DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/ConfirmOtp HTTP/1.1 
Host: legalguard-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"systemUserId":0,"otp":"String","utcOffset":0,"pushPlayerId":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"systemUserId":0,"refreshToken":"String","hasActivePanicCover":false,"accountInArrears":false,"updateClientInformation":false,"nextPanicDate":"String","panicReference":"String","clientData":{"firstName":"String","surname":"String","email":"String","mobileNumber":"String","address1":"String","address2":"String","city":"String","dateOfBirth":"String","sourceOfIncome":"String"}},"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"}}}