Each section of the client profile that is updated is sent as a separate message. The structure of each individual message is the same except for the details. The details section is dependent on the section of the profile that was changed.
{
"Client": {
"IntegrationId": "EX123456"
},
"Activity": {
"Identifier": "00000000-0000-0000-0000-000000000000",
"Type": "ClientProfile"
},
"Details": {
"FirstName": "Johnathan",
"LastName": "Farmer",
"DateOfBirth": "1980-05-28",
"TimeZone": "Mountain Standard Time",
"Gender": "Male",
"Ethinicity": "Caucasian",
"StaticRiskRating": "High - Violence",
"NeedsClassification": "High - Mental Health"
},
"Action": {
"Reason": "Personal Details Updated",
"OccurredOn": "2019-02-15T14:52:23.0272547Z",
"UpdatedBy": "officer@county.org"
}
}
| Details Element | Possible Values |
| FirstName | String |
| LastName | String |
| DateofBirth | date |
| TimeZone | String |
| Gender | String |
| Ethnicity | String |
| StaticRiskRating | String |
| NeedsClassification | String |
| Status | Active / inactive |
| AssignedCaseload | String |
| AssignedOfficer | String |
| String | |
| AddressType | Home / Work/ Other |
| Address | String |
| ContactType | HomePhone / MobilePhone / OtherPhone |
| Contact | String |
| Make (vehicle) | String |
| Model (vehicle) | String |
| Year (vehicle) | Date-Year |
| Color (vehicle) | String |
| LicensePlate (vehicle) | String |
| Employer (employment) | String |
| Occupation (employment) | String |
| WorkAddress (employment) | string |
| WorkPhone (employment) | String |
| Wage (employment) | Number |
| WageUnit (employment) | String |
| WorkEnvironment (employment) | String |
| CaseNumber (court case) | String |
| CaseDate (court case) | Date |
| Status (court case) | String |
| Label (offense) | String |
| Date (offense) | Date |
| statute (offense) | String |
| Category (offense) | String |
| IsPrimary (offense) | True/false |
| OrderType (protective order) | String |
| EffectiveDate (protective order) | Date |
| ExpirationDate (protective order) | Date |
| ProtectedPersons (protective order) | String |
| PeacefulContact (protective order) | True/false |
| NoContact (protective order) | True/false |
| StayAwayPersons (protective order) | String |
| StayAwayLocation (protective order) | String |
| StayAwayVehicles (protective order) | String |
| MoveOutAddress (protective order) | String |
| ChildCustody (protective order) | String |