Insure Guard App API

<back to all web services

UpdateClientDetail

Requires Authentication
import Foundation
import ServiceStack

public class UpdateClientDetail : ApiServiceRequest
{
    public var clientData:ClientData

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case clientData
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        clientData = try container.decodeIfPresent(ClientData.self, forKey: .clientData)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if clientData != nil { try container.encode(clientData, forKey: .clientData) }
    }
}

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

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

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

    required public init(){}
}

public class ClientData : Codable
{
    public var firstName:String
    public var surname:String
    public var email:String
    public var mobileNumber:String
    public var address1:String
    public var address2:String
    public var city:String
    public var dateOfBirth:String
    public var sourceOfIncome:String

    required public init(){}
}

public class UpdateClientDetailResponse : ApiServiceResponse
{
    public var validationMessages:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case validationMessages
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        validationMessages = try container.decodeIfPresent([String].self, forKey: .validationMessages) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if validationMessages.count > 0 { try container.encode(validationMessages, forKey: .validationMessages) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public var Description:String

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

    /**
    * 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 var wasSuccessful:Bool

    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift UpdateClientDetail 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/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
		}
	}
}