Insure Guard App API

<back to all web services

ConfirmOtp

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ConfirmOtp extends ApiServiceRequest
    {
        public Integer systemUserId = null;
        public String otp = null;
        public Integer utcOffset = null;
        /**
        * The user's push token - used for push messages.
        */
        @ApiMember(Description="The user's push token - used for push messages.")
        public String pushPlayerId = null;
        
        public Integer getSystemUserId() { return systemUserId; }
        public ConfirmOtp setSystemUserId(Integer value) { this.systemUserId = value; return this; }
        public String getOtp() { return otp; }
        public ConfirmOtp setOtp(String value) { this.otp = value; return this; }
        public Integer getUtcOffset() { return utcOffset; }
        public ConfirmOtp setUtcOffset(Integer value) { this.utcOffset = value; return this; }
        public String getPushPlayerId() { return pushPlayerId; }
        public ConfirmOtp setPushPlayerId(String value) { this.pushPlayerId = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String apiKey = null;

        /**
        * Latitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Latitude of the user making this request")
        public Double latitude = null;

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class ConfirmOtpResponse extends ApiServiceResponse
    {
        public LoginData data = null;
        
        public LoginData getData() { return data; }
        public ConfirmOtpResponse setData(LoginData value) { this.data = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String heading = 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)
        public Boolean wasSuccessful = null;

        public ResponseStatus responseStatus = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class LoginData
    {
        public Integer systemUserId = null;
        public String refreshToken = null;
        public Boolean hasActivePanicCover = null;
        public Boolean accountInArrears = null;
        public Boolean updateClientInformation = null;
        public String nextPanicDate = null;
        public String panicReference = null;
        public ClientData clientData = null;
        
        public Integer getSystemUserId() { return systemUserId; }
        public LoginData setSystemUserId(Integer value) { this.systemUserId = value; return this; }
        public String getRefreshToken() { return refreshToken; }
        public LoginData setRefreshToken(String value) { this.refreshToken = value; return this; }
        public Boolean isHasActivePanicCover() { return hasActivePanicCover; }
        public LoginData setHasActivePanicCover(Boolean value) { this.hasActivePanicCover = value; return this; }
        public Boolean isAccountInArrears() { return accountInArrears; }
        public LoginData setAccountInArrears(Boolean value) { this.accountInArrears = value; return this; }
        public Boolean isUpdateClientInformation() { return updateClientInformation; }
        public LoginData setUpdateClientInformation(Boolean value) { this.updateClientInformation = value; return this; }
        public String getNextPanicDate() { return nextPanicDate; }
        public LoginData setNextPanicDate(String value) { this.nextPanicDate = value; return this; }
        public String getPanicReference() { return panicReference; }
        public LoginData setPanicReference(String value) { this.panicReference = value; return this; }
        public ClientData getClientData() { return clientData; }
        public LoginData setClientData(ClientData value) { this.clientData = value; return this; }
    }

    public static class ClientData
    {
        public String firstName = null;
        public String surname = null;
        public String email = null;
        public String mobileNumber = null;
        public String address1 = null;
        public String address2 = null;
        public String city = null;
        public String dateOfBirth = null;
        public String sourceOfIncome = null;
        
        public String getFirstName() { return firstName; }
        public ClientData setFirstName(String value) { this.firstName = value; return this; }
        public String getSurname() { return surname; }
        public ClientData setSurname(String value) { this.surname = value; return this; }
        public String getEmail() { return email; }
        public ClientData setEmail(String value) { this.email = value; return this; }
        public String getMobileNumber() { return mobileNumber; }
        public ClientData setMobileNumber(String value) { this.mobileNumber = value; return this; }
        public String getAddress1() { return address1; }
        public ClientData setAddress1(String value) { this.address1 = value; return this; }
        public String getAddress2() { return address2; }
        public ClientData setAddress2(String value) { this.address2 = value; return this; }
        public String getCity() { return city; }
        public ClientData setCity(String value) { this.city = value; return this; }
        public String getDateOfBirth() { return dateOfBirth; }
        public ClientData setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
        public String getSourceOfIncome() { return sourceOfIncome; }
        public ClientData setSourceOfIncome(String value) { this.sourceOfIncome = value; return this; }
    }

}

Java ConfirmOtp DTOs

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

HTTP + JSV

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

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

{
	systemUserId: 0,
	otp: String,
	utcOffset: 0,
	pushPlayerId: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}