Understanding Service JSON
Table of Contents
Guide Purpose:
- This guide IS designed to:
- Show where to locate service JSON
- Show how to configure service JSON
- This guide IS NOT designed to:
- Show how to edit service JSON
*PLEASE DO NOT MAKE ANY CHANGES TO THE JSON ARRAY*
How to Locate JSON Configuration
- Click on “Administration” Tab
- Select “Configuration” button
- Select “Companies” button
- Search and select the tenant
- For the purpose of this guide, we will use the master tenant “3rd Eye”
- Review the configuration field for Service and Safety JSON as highlighted in the BLUE bo
How to Configure a Service JSON
-
“Code”:10
This line identifies the tagged code for the use case the tenant is requesting for as highlighted in the RED box- This JSON should not be changed
- This JSON should always align with the approved JSON
-
“name”: “Bulk”
This line provides the name of the used case associated with the code as highlighted in the BLUE box- This JSON should not be changed
- This JSON should always align with the approved JSON
-
“autoEmailNotification”: true and “email”
This JSON lines cane be ignored and should be left alone. This section is highlighted in GREEN -
“lobs”
This line identifies the line of businesses the tagged code will be used for as highlighted in the BLACK box. This line of business is categorized in number values- 0 = Commercial, 1 = Residential, 2 = Industrial, and 3 = Container Delivery
- 0 = Commercial, 1 = Residential, 2 = Industrial, and 3 = Container Delivery
-
“reviewerCallback”: true
This JSON allows notification to be sent to the tenant that an event has been reviewed as highlighted in the RED box. The value for this should always be true -
“mediaType”
This JSON specifies the format in which event will be reviewed as highlighted in the BLUE box. There are only 2 options on how events can be reviewed- “Jpeg”: this is the format used for still images
- “video”: this is the format used for visual media product featuring moving images
-
“mediaCamera”: 3,
This JSON identifies the specific number label of the camera where media events will be captured from as highlighted in the GREEN box -
“mediaPosition”: “PSV”
This JSON identifies the camera functionality the cameras as been assigned for as highlighted in the BLACK box- For now, we only consider 2 options for service which are Positive Service Verification (PSV) and Contamination.
-
“bodyType”:
This JSON identifies the type of body installed on the vehicle as highlighted in the PURPLE box. The 3-letter acronym are used for identification
Multiple Service JSON Array
If multiple service use cases is required by the Tenant, it is important to make sure we arrange the “name” JSON of the different use cases in alphabetical order. Please review the image below as each use case is sectioned off in different colors.
- The first section highlighted in RED shows the Bulk JSON array code
- The second section highlighted in BLUE shows the Contamination- Commercial JSON array code
- The third section highlighted in GREEN shows the Overloaded Container JSON array code
How Tenants Can view Use Cases
- Click on the “Events to Review” tab
- Select service button
- Select the drop down to view available uses cases as highlighted in the BLUE box