Background and strategic fit

The purpose of this Integration is to pull over different Property Damage Incident Details to support our growing customer base to analyze the data they are entering through the ProcessMAP solution.This document provides information on how to consume the API's by the end Users.

Assumptions

ProcessMAP system User permissions would not be considered while exposing the data
ProcessMAP assumes anyone who is accessing the Outbound API has required authority to access Personal Information
User would have to input single Location Code(e.g. Westlake) each time to consume that Location data
Data to be accessed with a limitation of 2 years duration at a time to avoid any performance issues.
Data will be shown in Readable JSON format
Fields Names in the Response can use mapping documentation provided in order to map the JSON Response as per application fields.
User accessing this endpoint through a valid Token & ConsumerId, provided by ProcessMAP, will have access to complete data
Witness Details Information will be as nested
The data that is being shown in response is in EST Date time format ONLY
Certain fields are auto-populated in Application but the same will not reflect in JSON until the form is saved

User Interaction

Implementation :

AUTHENTICATION URL DETAILS [ Base URL with Auth EndPoint ]

Environment	Auth URL
UAT	https://integrationsvc.uat.pmapconnect.com/product/papi/v1/auth
Production	https://integrationsvc.processmap.com/product/papi/v1/auth

Please note that the above Auth Token expires after every 120 minutes.

BASE URL FOR RESPECTIVE API CALLS :

Environment	Base URL
UAT	https://integrationsvc.uat.pmapconnect.com/outbound/
Production	https://integrationsvc.processmap.com/outbound/

PropertyDamage

Incident Details

Request

GET papi/v1/imsoutbound/propertydamageincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}

Ex: papi/v1/imsoutbound/propertydamageincidents?locationCode=westlake&dateFrom=2019-07-01&dateTo=2019-07-30&lastSyncedDate=2019-01-01

URI Parameters

Location Code, DateFrom, DateTo and LastSyncedDate are to be passed as parameters.

DateFrom and DateTo are required when LastSyncedDate is not provided.

When DateFrom, DateTo and LastSyncedDate are provided, data will be returned based on LastSyncedDate only.

Name	Description	Type	Additional information
locationCode	Represents the unique code of location for which Incident records to return.	string	Required
dateFrom	Represents the starting date of Incident records to return.	date	Required but value optional
dateTo	Represents the ending date of Incident records to return.	date	Required but value optional
lastSyncedDate	Represents the data from incident created date or incident modified date.	date	Required but value optional

Headers

Name	Description	Sample
Authorization	Represents the value of the authentication token. Allow multiple values: no.	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ...
ConsumerId	Represents the value of the consumer id. Allow multiple values: no.	2426

Response

Sample:

[{
    "IncidentID": "sample string",
	
	"InternalIncidentID": "sample string",
    
	"IncidentTitle": "sample string",

    "LocationCode": "sample string",

    "Location": "sample string",

    "IncidentDate": "2019-10-06T00:00:00.000Z",

    "TimeofIncident": "sample string 2",

    "TimeUndetermined": "sample string",

    "DayOfWeek": "sample string",

    "JobShift": "sample string",

    "TimeWorkDayBegan": "sample string",

    "hasthePotentialtobeSerious": "sample string",
	
    "DescriptionofIncident": "sample string",
    
    "IncidentOccurredonEmployerPremises": "sample string",
  
    "Department": "sample string",
	
    "PinLocation": "sample string",
    
    "AddressofIncidentLocation": "sample string",

    "City": "sample string",

    "County": "2019-10-06T00:00:00.000Z",

    "Country": "sample string 2",

    "State": "sample string",

    "ZipCode": "sample string",

    "WasAssetinvolved": "sample string",

    "Assets": [{

       "sample string 2"
    }],

    "ConfirmSignificancelevelofincident": "sample string",

    "WasCorrectiveActioncompleted": "sample string",

    "ActionItemTitle": "2019-10-06T00:00:00.000Z",

    "ActionTaken": "sample string 2",

    "PrimaryOwner": "sample string",

    "AssignedBy": "sample string",

    "CompletionDate": "sample string",

    "DateandTimeReportedtoEmployer": "sample string",

    "WasEmployeeinvolvedintheIncident": "sample string",
	  
	"EmployeeDetails": 
	 {
	  
      "PersonnelType": "sample string",
	  
	  "EmployeeInvolved": "sample string",
	  
	  "EmployeeId": "sample string",
	  
	  "PayRateType": "sample string",
	  
	  "EmployeeDepartment": "sample string",
	  
	  "Contractor": "sample string",
	  
	  "DoyouwanttoclassifyUnsupervisedContractEmployee": "sample string",
	  
	  "TypeofClientPersonnel": "sample string",
	  
	  "ClientCompany": "sample string",
	  
	  "NameofContractor": "sample string",
	  
	  "NameofSubContractor": "sample string"
	 
	} ,
	  
	"WasMachineinvolved": "sample string",
	  
	"MachineNumber": "sample string",
	  
	"ReviewedbyEHSRepresentative": "sample string",
	  
	"ReviewDate": "sample string",
	  
	"Property Damage Incident Details":
	{
	    "IncidentType": "sample string",
		
		"IsthisachargeableIncident": "sample string",
		
		"CauseofIncident": "sample string"
	}
	 
	"DamageSummary":
	{
	    "Wascontractorinvolvedintheincident": "sample string",
		
		"PleaseprovideContractorDetails": "sample string",
		
		"Wasthecontractortrainedoncompanypolicies": "sample string",
		
		"Describeanydamagecaused": "sample string",
		
		"Describewhatcausedtheincidenttooccur": "sample string",
		
		"Describeworkactivitybeingperformedduringincident": "sample string",
		
		"Wastheapplicableregulatoryagencynotified": "sample string"
	}

    "ArethereanyWitnessesidentified": "sample string",

    "NumberofWitnesses":  "sample string",

    "WitnessInformation":
    [ {

         "LastName": "sample string 2",

         "FirstName": "sample string 3",

         "MiddleName": "sample string 4",

         "Notes": "sample string 6",
		 
		 "PhoneNumber": "sample string 6",

         "WitnessrealtiontoProcessMAP": "sample string 6"

    } ],

    "IncidentStatus": "sample string",

    "CreatedBy": "sample string",

    "CreatedDate": "2019-10-14T11:43:31.517Z",

    "LastUpdatedDate": "2019-10-14T11:47:29.440Z",

    "LastUpdatedBy": "sample string"   
}]

JSON Field Mapping with respect to Application Fields :

JSON Field	ProcessMAP System Field
IncidentID	Incident ID (System Generated)
InternalIncidentID
IncidentTitle	Incident Title/Site
LocationCode	Location Code
Location
IncidentDate	Date of Incident
TimeofIncident	Time of Incident
TimeUndetermined
DayOfWeek	Day Of Week
JobShift	Job Shift
TimeWorkDayBegan	Time Work Day Began
hasthePotentialtobeSerious	Is this a serious Incident or has the Potential to be Serious?
DescriptionofIncident	Description of Incident
IncidentOccurredonEmployerPremises	Incident Occurred on Employer's Premises
Department
PinLocation
AddressofIncidentLocation	Address of Incident Location
City	City
County	County
Country	Country
State	State/Province
ZipCode	Postal Code/Zip Code
WasAssetinvolved	Was Asset involved?
Assets	Select Asset(s)
WasCorrectiveActioncompleted
ActionItemTitle
ActionTaken
PrimaryOwner
AssignedBy
CompletionDate
DateandTimeReportedtoEmployer	Date & Time Reported to Employer
ConfirmSignificancelevelofincident	Confirm Significance Level of Incident
EmployeeDetails	Employee / Individual Details
WasEmployeeinvolvedintheIncident	Was an Employee / Individual involved in the Incident?
PersonnelType	Personnel Type
EmployeeInvolved	Employee / Individual Involved( Last, First, M.I.)
EmployeeId	Employee Id
PayRateType	Pay Rate Type
EmployeeDepartment	Employee / Individual Department
Contractor	Contractor
DoyouwanttoclassifyUnsupervisedContractEmployee	Do you want to further classify Unsupervised Contract Employee
TypeofClientPersonnel	Type of Client Personnel
ClientCompany	Client Company
NameofContractor	Name of Contractor
NameofSubContractor	Name of SubContractor
WasMachineinvolved
MachineNumber
ReviewedbyEHSRepresentative
ReviewDate
PropertyDamageIncidentDetails	Property Damage Incident Details
IncidentType	Incident Type
IsthisachargeableIncident	Is this a chargeable Incident
CauseofIncident	Cause of Incident
DamageSummary	Damage Summary
Wascontractorinvolvedintheincident	Was contractor involved in the incident
PleaseprovideContractorDetails	Please provide Contractor Details
Wasthecontractortrainedoncompanypolicies	Was the contractor trained on company policies
Describeanydamagecaused	Describe any damage caused
Describewhatcausedtheincidenttooccur	Describe what caused the incident to occur
Describeworkactivitybeingperformedduringincident	Describe work activity being performed during incident
Wastheapplicableregulatoryagencynotified	Was the applicable regulatory agency notified
WitnessInformation	Witness Information
ArethereanyWitnessesidentified	Are there any Witnesses identified
NumberofWitnesses	Number of Witnesses
LastName	LastName
FirstName	FirstName
MiddleName	MiddleName
Notes	Notes
PhoneNumber	Phone Number
WitnessrealtiontoProcessMAP	Witness Relation to ProcessMAP (Coworker, friend, public, supervisor, venue employee)
IncidentStatus
CreatedBy
CreatedDate
LastUpdatedDate
LastUpdatedBy

IMS Property Damage Outbound API