| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientData | query | ClientData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Latitude | form | double | No | Latitude of the user making this request |
| Longitude | form | double | No | Longitude of the user making this request |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | No | |
| Surname | form | string | No | |
| form | string | No | ||
| MobileNumber | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| DateOfBirth | form | string | No | |
| SourceOfIncome | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ValidationMessages | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | Yes | Information about the response. |
| Heading | form | string | Yes | Heading or summary of the response. |
| WasSuccessful | form | boolean | Yes | Did the intended operation for this response complete successfully? |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}