Overview
Central Square Pro Suite provides a robust reporting suite that can be exposed via interfaces. The high level steps to expose a set of data from a report is to
Create a Report - Create a report with the required fields
Create an Interface User - This only needs to be done once and can be reused across interfaces
Create an Interface - Create an interface and link the report to an interface. The interface description will determine the url to consume the interface
Once creating an interface you can test it works by browsing to the following URL
https://{agency}.zuercherportal.com/interfaces/{interfacename}.json?username={interfaceusername}&password={interfaceuserpassword}So a full URL based on a created interface might be
https://{agency}.zuercherportal.com/interfaces/govworxincidents.json?username=govworx&password=govworxOur data agent will read these endpoints from within the network. Our data agent expects a set of interfaces specifically named and with field names case sensitive and exact.
Required Interfaces
Incidents
Interface Name: govworxincidents
Report Main Item: CFS
CS Pro Field | Interface Field Name |
CFS # | CFS_number |
Priority | Priority |
Primary Incident Code -> Code : Description | Code_Description |
CFS Date/Time | CFS_Date_Time |
From Phone | From_Phone |
Initial Reporter -> Caller Name | Person_Business_Name |
Primary Disposition -> Code with Description | Code_With_Description |
Address -> Address | Address |
Dispatcher -> Username | Username |
Dispatcher -> User Last, First Name | Last_First_Name |
911 Call -> Received Time | | CFS_Date_Time |
Completed Date / Time | Completed_Date_Time |
Incident Notes
Interface Name: govworxincidentnotes
Report Main Item: CAD Command Log
Interface Filter: CFS_number
CS Pro Field | Interface Field Name |
CFS # | CFS_number |
Date/Time | Date_Time |
User Last, First Name | Last_First_Name |
Command / Message | Command_Message |
Incident Audit Trail
Interface Name: govworxincidentaudit
Report Main Item: Audit Trail
Interface Filter: Record_number
CS Pro Field | Interface Field Name |
Record # | Record_number |
Computer Name | Computer_Name |
Date | Date |
User -> username | Username |
Incident Responders
Interface Name: govworxincidentresponders
Report Main Item: CFS Units
Interface Filter: CFS_number
CS Pro Field | Field Name |
CFS -> CFS # | CFS_number |
Unit -> Unit | Unit |
Dispatcher -> username | Username |
First Assigned Date | First_Assigned_Date_Time |
First Enroute Date | First_Enroute_Date_Time |
First On Scene Date | First_On_Scene_Date_Time |
Last Unit Cleared Time | Completed_Date_Time |
Data Agent Connector Settings
Field | Entry |
Host | Location of interface reports (https://{agency}.zuercherportal.com/interfaces) |
Username | Interface Username |
Password | Interface Password |