API Example Create Person
API URL
https://securelb.trackerproducts.com/api/people
The Safe system, for Persons, is built on the premise of a Unique Person. We want, if possible, to avoid having multiple people in the system that are actually the same person. Before submitting a new Person, you should check to see if that person is already in the system. See notes below for 'Duplicate Persons Detection'
Fields used in Post
All Fields in the JSON example are Text-based fields and not required unless listed in the following rows.
ID [Required and must be 0]
First Name & Last Name OR Business Name [Required, Text]
Email [Not required]
Emails do not need to be unique for people in the system.
However, you can use the following to check for email already in the system: https://securelb.trackerproducts.com/api/people/isemailalreadyinuse/email@address.com/ (Be sure to include the / at the end.)
RaceID [Required Integer]
GET https://securelb.trackerproducts.com/api/races (1 = Unknown, 2 = African American or Black, 3 = American Indian or Alaska Native, 4 = Asian, 5 = Native Hawaiian or Other Pacific Islander, 6 = White, 7 = Hispanic, 8 = Middle Eastern)
GenderID [Required Integer]
GET https://securelb.trackerproducts.com/api/genders (1 = Unknown, 2= Female, 3 = Male )
DOB [Not required, Date / Time]
Active [Required, True or False]
Deceased [Required, True or False (Submit as False if unknown)]
Juvenile [Required, True or False (Submit as False if unknown)]
personTypeId [This can be null if you are not adding the person to a case. Available person Types can be obtained here: https://securelb.trackerproducts.com/api/personTypes ]
ID, Date & EntityID (Address Field) [These are all placeholders and submitted values will not be used]
AddressTypeID [Required Integer IF address is submitted]
GET https://securelb.trackerproducts.com/api/addresstypes (1 = Home, 2 = Work, 3 = Other)
StateID [No required]
GET https://securelb.trackerproducts.com/api/states (55 options available)
CountryID [Required Integer IF address is submitted]
GET https://securelb.trackerproducts.com/api/countries (USA ID = 231)
Example JSON For Adding A Person
{"person":
{
"id":0,
"businessName":"Tracker Products",
"firstName":"Bob",
"middleName":"Edward",
"lastName":"Smith",
"alias":"Big Bob",
"mobilePhone":"123-456-7890",
"otherPhone":"987-654-3210",
"email":"bigbobsmith@trackerproducts.com",
"driverLicence":"",
"raceId":1,
"genderId":2,
"dob":"1960-07-07T00:00:00.000Z",
"active":true,
"deceased":true,
"juvenile":true,
"notes":[],
"addresses":[],
"formData":[],
"personTypeId":null
},
"address":
{
"id":0,
"date":"2017-12-04T20:35:33.125Z",
"entityId":0,
"line1":"1 Symphony Way",
"line2":"",
"city":"Vienna",
"zip":"1001",
"stateId":"",
"addressTypeId":1,
"countryId":231,
"isDefaultAddress":true
}
}
Duplicate Person Detection
When submitting a Person via POST, we are doing a check for potential duplicate people in the system. We check the following fields to determine if a potential duplicate exists:
Driver's License
Business Name
Duplicate Name (FirstName LastName)
If when posting a Person that is considered a duplicate, you will get this response.
At this point you can do one of two things:
Get the Person ID for the returned Person and move to Attach Existing Person to Existing Case
Proceed and post to postDuplicate endpoint. https://securelb.trackerproducts.com/api/people/postDuplicate
Person Post With Custom Form Data
When creating a new person in the system, a post can also include custom form data. Here is an example post of a person with a custom form:
POST Person With Form Data
Add Person to Case after Submit
To Add the Person submitted to an Existing Case, take the ID returned in the Person Post and go to Attach Existing Person to Existing Case