Insure Guard App API

<back to all web services

ConfirmOtp

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ConfirmOtp : ApiServiceRequest()
{
    var systemUserId:Int? = null
    var otp:String? = null
    var utcOffset:Int? = null
    /**
    * The user's push token - used for push messages.
    */
    @ApiMember(Description="The user's push token - used for push messages.")
    var pushPlayerId: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 ConfirmOtpResponse : ApiServiceResponse()
{
    @SerializedName("data") var Data:LoginData? = 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
}

open class LoginData
{
    var systemUserId:Int? = null
    var refreshToken:String? = null
    var hasActivePanicCover:Boolean? = null
    var accountInArrears:Boolean? = null
    var updateClientInformation:Boolean? = null
    var nextPanicDate:String? = null
    var panicReference:String? = null
    var clientData:ClientData? = null
}

open class ClientData
{
    var firstName:String? = null
    var surname:String? = null
    var email:String? = null
    var mobileNumber:String? = null
    var address1:String? = null
    var address2:String? = null
    var city:String? = null
    var dateOfBirth:String? = null
    var sourceOfIncome:String? = null
}

Kotlin ConfirmOtp DTOs

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

HTTP + XML

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

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

<ConfirmOtp 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>
  <Otp>String</Otp>
  <PushPlayerId>String</PushPlayerId>
  <SystemUserId>0</SystemUserId>
  <UtcOffset>0</UtcOffset>
</ConfirmOtp>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConfirmOtpResponse 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>
  <Data>
    <AccountInArrears>false</AccountInArrears>
    <ClientData>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <City>String</City>
      <DateOfBirth>String</DateOfBirth>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <MobileNumber>String</MobileNumber>
      <SourceOfIncome>String</SourceOfIncome>
      <Surname>String</Surname>
    </ClientData>
    <HasActivePanicCover>false</HasActivePanicCover>
    <NextPanicDate>String</NextPanicDate>
    <PanicReference>String</PanicReference>
    <RefreshToken>String</RefreshToken>
    <SourceOfIncomeOptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </SourceOfIncomeOptions>
    <SystemUserId>0</SystemUserId>
    <UpdateClientInformation>false</UpdateClientInformation>
  </Data>
</ConfirmOtpResponse>