"use strict";
export class ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
apiKey;
/**
* @type {number}
* @description Latitude of the user making this request */
latitude;
/**
* @type {number}
* @description Longitude of the user making this request */
longitude;
}
export class ApiServiceResponse {
/** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Information about the response. */
description;
/**
* @type {string}
* @description Heading or summary of the response. */
heading;
/**
* @type {boolean}
* @description Did the intended operation for this response complete successfully? */
wasSuccessful;
/** @type {ResponseStatus} */
responseStatus;
}
export class ClientData {
/** @param {{firstName?:string,surname?:string,email?:string,mobileNumber?:string,address1?:string,address2?:string,city?:string,dateOfBirth?:string,sourceOfIncome?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
firstName;
/** @type {string} */
surname;
/** @type {string} */
email;
/** @type {string} */
mobileNumber;
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
city;
/** @type {string} */
dateOfBirth;
/** @type {string} */
sourceOfIncome;
}
export class LoginData {
/** @param {{systemUserId?:number,refreshToken?:string,hasActivePanicCover?:boolean,accountInArrears?:boolean,updateClientInformation?:boolean,nextPanicDate?:string,panicReference?:string,clientData?:ClientData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
systemUserId;
/** @type {string} */
refreshToken;
/** @type {boolean} */
hasActivePanicCover;
/** @type {boolean} */
accountInArrears;
/** @type {boolean} */
updateClientInformation;
/** @type {string} */
nextPanicDate;
/** @type {string} */
panicReference;
/** @type {ClientData} */
clientData;
}
export class ConfirmOtpResponse extends ApiServiceResponse {
/** @param {{data?:LoginData,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {LoginData} */
data;
}
export class ConfirmOtp extends ApiServiceRequest {
/** @param {{systemUserId?:number,otp?:string,utcOffset?:number,pushPlayerId?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
systemUserId;
/** @type {string} */
otp;
/** @type {number} */
utcOffset;
/**
* @type {string}
* @description The user's push token - used for push messages. */
pushPlayerId;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>