Insure Guard App API

<back to all web services

AutoLogin

AutoLogin Parameters:
NameParameterData TypeRequiredDescription
UtcOffsetqueryintNo
SystemUserIdqueryintNo
RefreshTokenquerystringNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
AutoLoginResponse Parameters:
NameParameterData TypeRequiredDescription
DataformLoginDataNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
LoginData Parameters:
NameParameterData TypeRequiredDescription
SystemUserIdformintNo
RefreshTokenformstringNo
HasActivePanicCoverformboolNo
AccountInArrearsformboolNo
UpdateClientInformationformboolNo
NextPanicDateformstringNo
PanicReferenceformstringNo
ClientDataformClientDataNo
ClientData Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
SurnameformstringNo
EmailformstringNo
MobileNumberformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
DateOfBirthformstringNo
SourceOfIncomeformstringNo

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/AutoLogin HTTP/1.1 
Host: legalguard-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	utcOffset: 0,
	systemUserId: 0,
	refreshToken: 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
		}
	}
}