Insure Guard App API

<back to all web services

UpdateClientDetail

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

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

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

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

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public heading: string;

    /** @description 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 wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class UpdateClientDetailResponse extends ApiServiceResponse
{
    public validationMessages: string[];

    public constructor(init?: Partial<UpdateClientDetailResponse>) { super(init); (Object as any).assign(this, init); }
}

export class ClientData
{
    public firstName: string;
    public surname: string;
    public email: string;
    public mobileNumber: string;
    public address1: string;
    public address2: string;
    public city: string;
    public dateOfBirth: string;
    public sourceOfIncome: string;

    public constructor(init?: Partial<ClientData>) { (Object as any).assign(this, init); }
}

export class UpdateClientDetail extends ApiServiceRequest
{
    public clientData: ClientData;

    public constructor(init?: Partial<UpdateClientDetail>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UpdateClientDetail DTOs

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

{
	clientData: 
	{
		firstName: String,
		surname: String,
		email: String,
		mobileNumber: String,
		address1: String,
		address2: String,
		city: String,
		dateOfBirth: String,
		sourceOfIncome: String
	},
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	validationMessages: 
	[
		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
		}
	}
}