Insure Guard App API

<back to all web services

ConfirmOtp

namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ClientData() = 
        member val FirstName:String = null with get,set
        member val Surname:String = null with get,set
        member val Email:String = null with get,set
        member val MobileNumber:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val SourceOfIncome:String = null with get,set

    [<AllowNullLiteral>]
    type LoginData() = 
        member val SystemUserId:Int32 = new Int32() with get,set
        member val RefreshToken:String = null with get,set
        member val HasActivePanicCover:Boolean = new Boolean() with get,set
        member val AccountInArrears:Boolean = new Boolean() with get,set
        member val UpdateClientInformation:Boolean = new Boolean() with get,set
        member val NextPanicDate:String = null with get,set
        member val PanicReference:String = null with get,set
        member val ClientData:ClientData = null with get,set

    [<AllowNullLiteral>]
    type ConfirmOtpResponse() = 
        inherit ApiServiceResponse()
        member val Data:LoginData = null with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ConfirmOtp() = 
        inherit ApiServiceRequest()
        member val SystemUserId:Int32 = new Int32() with get,set
        member val Otp:String = null with get,set
        member val UtcOffset:Int32 = new Int32() with get,set
        ///<summary>
        ///The user's push token - used for push messages.
        ///</summary>
        [<ApiMember(Description="The user's push token - used for push messages.")>]
        member val PushPlayerId:String = null with get,set

F# 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>