Not logged in - Login
< back

API Overview

General Purpose of the Safe API

Tracker clients will generally use the API for the following tasks.

  1. Creating, Updating or Reading system User Accounts (User Admin)
  2. Creating, Updating or Reading Case information
  3. Creating, Updating or Reading Person information
  4. Reading new Items information
  5. Reading updated items information

Note: We do not support injecting item information via the API. Items must always be created via the Item entry or Data Import areas.

Note: While there are many other systems API's, the ones we are listing here are those that are generally used..

Requirements for each API request

Each request made to the SAFE webAPI will require the following

  1. Valid URL (from list of available URLs below)
  2. User Token
  3. Valid OrgID # (See instructions below for getting this)
  4. Valid Office ID # (See instructions below for getting this)

Getting a valid User Token

  1. Go to Settings -> Users
  2. Select a user in which to create a static token for, and select ‘Edit’ (Or you may want to create a new user for this process)
  3. At the bottom of the edit screen will be the token create section:
  4. Press ‘Generate’ to create the token.
  5. NOTE: If you created a token for the currently logged in user, then you must logout before using the token.

Setting a Static License

In most cases, you are going to want to peg a license to the user that was created in the previous step. This will ensure that a license is available when the interface makes a call to the SAFE webAPI. If not license is available, then the API will respond with a message that no licenses are available.
  1. Go to Settings > License Allocation
  2. In the column ‘Reserved for Individual Users’ find the user you created for the API and then select the ‘No’ value to set a license.

Warning Making an API call to the database more than once a minute will most likely cause your account to be disabled. It is highly recommended that you make (or schedule) your call every 10 minutes or so.

Testing the Tracker API

  1. The user can test communicating to the Tracker API using Postman in Chrome, or any similar tool. The following example is using Postman:
  2. Header Fields
    1. Accept application/json – required field
    2. Content-Type application/x-www-form-urlencoded – required field
    3. Authorization – This field requires the word ‘Bearer’ followed by a single space and then the static token that was created.
    4. OrganizationId – the organization ID to use
    5. OfficeId – the office ID to use
    6. StaticToken – tells the API that the bearer token is static
  3. Once these fields are in place, select ‘Send’ and verify that an item was returned (if one exists).

Note: make sure you have a valid item in the system before you try to select one from the webAPI.

POST or GET Data from API

Retrieving Items Data

API URL = https://securelb.trackerproducts.com/api/items/SeqOrgID/X

Where X = the next Org ID

Type POST


Retrieving an Updated Item

API URL - https://securelb.trackerproducts.com/api/items/seqUpdateOrgId/X

Required fields:

  • seqUpdateOrgId [long]

Returns:

  • The Item that was updated

Type GET


Retrieving Custom Data – Formdata Controller

API URL = https://securelb.trackerproducts.com/api/items/XXXXX/formdata

Where XXXXX = the "id" value that is provided in the seqOrgID controller listed above

This Formdata controller will come back with every custom data form and field that is attached to this item. { "id": "5750570d1b5c6008e8e4fcec", "active": true, "entityId": 994601, "formId": 1, "formName": "Drug Form Sys Template", "dateFields": null, "data": "{ \"field2849\" : \"1\", \"field7312\" : \"1\", \"field5100\" : true, \"field7289\" : true, \"field6199\" : 1, \"field5088\" : 2, \"field5091\" : 3, \"field5094\" : 4, \"field5097\" : 5, \"field5970\" : 6 }", "organizationId": 1, "officeId": 1, "visibilityId": 1 } ]


The data you are looking for is in the “Data” section.

Retrieving Case Data

API URL = https://securelb.trackerproducts.com/api/cases/XXXXX Where XXXXX = the "PrimaryCaseID" value that is provided in the seqOrgID controller listed above

Retrieving People in a Case

API URL = https://securelb.trackerproducts.com/api/cases/XXXXX/peopleList/

Where XXXXX = the "PrimaryCaseID" value that is provided in the seqOrgID controller listed above


Retrieving Chain of Custody

API URL = https://securelb.trackerproducts.com/api/items/XXXXX/coc

Where XXXXX = the "id" value that is provided in the seqOrgID controller listed above


Case Data Post

API URL = https://securelb.trackerproducts.com/api/cases

Required fields:

  • CaseOfficerId [long]
  • OffenseTypeId [long]
  • CaseNumber [string]
  • FormData [List]
  • FormId [long]
  • Data [string]
  • Tags [List]
  • tagModelId [long]
  • Name [string]

Optional:

  • OffenseDescription [string]
  • OffenseLocation [string]
  • OffenseDate

Person Data Post

API URL - https://securelb.trackerproducts.com/api/people

Required fields:

  • RaceId [long]
  • GenderId [long]
  • FirstName [string]
  • LastName [string]

Optional:

  • MiddleName [string]
  • Alias [string]
  • MobilePhone [string]
  • OtherPhone [string]
  • Email [string]
  • DriverLicense [string]
  • Dob [date]
    • FormData [List]
    • FormId [long]
    • Data [string]