The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
uuid: String,
regent_id: 0,
sugar_bio:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
prefix: String,
dob: 0001-01-01,
citizenship: String,
citizenship_code: String,
citizenship_other: String,
permanent_resident: String,
citizenship_other_code: String,
permanent_resident_code: String,
gender: String,
gender_code: String,
marital_status: String,
marital_status_code: String,
deceased_date: 0001-01-01,
added_by: String,
added_date: 0001-01-01,
changed_by: String,
changed_date: 0001-01-01
},
regis_bio:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
prefix: String,
dob: 0001-01-01,
citizenship: String,
citizenship_code: String,
citizenship_other: String,
permanent_resident: String,
citizenship_other_code: String,
permanent_resident_code: String,
gender: String,
gender_code: String,
marital_status: String,
marital_status_code: String,
deceased_date: 0001-01-01,
added_by: String,
added_date: 0001-01-01,
changed_by: String,
changed_date: 0001-01-01
},
re_bio:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
prefix: String,
dob: 0001-01-01,
citizenship: String,
citizenship_code: String,
citizenship_other: String,
permanent_resident: String,
citizenship_other_code: String,
permanent_resident_code: String,
gender: String,
gender_code: String,
marital_status: String,
marital_status_code: String,
deceased_date: 0001-01-01,
added_by: String,
added_date: 0001-01-01,
changed_by: String,
changed_date: 0001-01-01
},
exists_in_sugar: False,
exists_in_re: False,
are_equal: False,
first_name_are_equal: False,
middle_name_are_equal: False,
last_name_are_equal: False,
preferred_name_are_equal: False,
birth_name_are_equal: False,
prefix_are_equal: False,
dob_are_equal: False,
deceased_are_equal: False,
citizenship_are_equal: False,
gender_are_equal: False,
marital_status_are_equal: False
}