Background and strategic fit

The purpose of this Integration is to pull over different General Liability 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

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+Endpoint FOR RESPECTIVE API CALLS :

Environment	Base URL	Method

Environment	Base URL	Method
UAT	https://integrationsvc.uat.pmapconnect.com/outbound/papi/v1/imsoutbound/generalLiabilityincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}	Get
Production	https://integrationsvc.processmap.com/outbound/papi/v1/imsoutbound/generalLiabilityincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}	Get

GeneralLiability

Incident Details

Request

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

Ex: papi/v1/imsoutbound/generalliabilityincidents?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

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

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:

[{
  "GeneralLiabilityIncidentDetails": {
        "IncidentDetails": {
			"IncidentInternalID": "sample string",
			"IncidentIDSystemGenerated": "sample string",
			"IncidentTitleSite": "sample string",
		    "IncidentType": "sample string",
			"LocationCode": "sample string",
			"Location": "sample string"
        },
        "GeneralDetails": {
			"WouldyouliketosubmitaGeneralLiabilityClaim": "sample string",
		    "GeneralLiabilityType": "sample string",
			"Sub-incidentType": "sample string",
			"DateOfIncident": "2022-10-04T00:00:00.000Z",
			"TimeOfIncident": "12:25",
			"TimeUndetermined": "sample string",
			"DayOfWeek": "sample string",
			"WorkShift": "sample string",
			"TimeWorkDayBegan": "sample string",
			"DescriptionofIncident": "sample string",
		    "DateReportedtoEmployer": "2022-10-27T00:00:00.000Z",
			"TimeReportedtoEmployer": "-",
			"WasAssetinvolved": "sample string",
			"Assets": [{
			    "sample string 2"
			}],
		    "Significance": "sample string"
        },
	    "PersonDetails": [{
			"Wereindividualsinvolvedintheincident": "sample string",
			"Numberofinvolvedindividuals": 1
			},
			{
			"Name": "sample string",
			"Gender": "sample string",
			"DateOfBirth": "sample string",
			"HomeAddress": "sample string",
			"City": "sample string",
			"State": "sample string",
			"Zip": "sample string",
			"PhoneNumber": "sample string",
			"Whatwaspersondoingbeforeincident": "sample string",
			"Wasindividualinjuredintheincident": "sample string",
			"DidInjuryresultinaFatality": "sample string", 
			"ResultofIncident": "sample string",
			"CauseofIncident": "sample string",
			"InjuredBodyPart": "sample string",
			"Pleasedescribepersonsinjury": "sample string", 
			"Waspersonconsideredminor": "sample string",
			"Pleaseprovideparentsname": "sample string", 
			"Pleaseprovideparentsphonenumber": "sample string", 
			"Takenfromsceneviaambulance": "sample string",
			"Whatshoeswasclaimantwearing": "sample string",
			"Wasclaimantstruckbyobject": "sample string",
			"Ifstruckbyobjectwhatobject": "sample string",
			"Didthepersonrefusetreatment": "sample string",
			"IfYesexplainwhy": "sample string",
			"Wastreatmentprovided": "sample string",
			"DidthepersonsignthemedicalreleaseformIfyespleaseattach": "sample string",
			"WereEmergencyServicescalled?": "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"
	    },
	    "LocationOfIncident": {  
			"IncidentOccurredonEmployersPremises": "sample string",
			"AddressofIncidentLocation": "sample string",
			"City": "sample string",
			"County": "sample string",
			"State": "sample string",
			"Zip": "sample string",
			"Department": "sample string",
			"PinLocation": "sample string",
			"LocationoftheIncident": "sample string",
			"StoreManagerName ": "sample string",
			"StoreManagerPhone": "sample string",
			"DistrictManagerName": "sample string", 
			"DistrictManagerPhone": "sample string",
			"Wasanythingonfloor": "sample string",
			"Floorgroundscondition": "sample string",
			"Incidentoccurinsideoutside": "sample string",
			"IfInsidestorewhere": "sample string",
			"IfInsidestorecause": "sample string",
			"IfinStockroomwhere": "sample string",
			"IfOutsidestorewhere": "sample string",
			"IfOutsidestorecause": "sample string",
			"Istherevideooftheincident": "sample string",
			"Ifvideonotobtainedwhy": "sample string",
			"IfEquipnotfunctionalWhy": "sample string",
			"Didtheincidentresultinanydamagetocompanyequipment": "sample string",                                               
			"Pleasedescribeequipmentanddamage": "sample string",  
			"Didtheincidentresultinanystructuraldamage": "sample string",
			"Pleasedescribedamage": "sample string",
			"Wastheincidentaresultoftheftorasecurityrelatedactivity": "sample string",                                  
			"Pleasedescribetheftorsecurityrelatedincident": "sample string",                                                                                      
			"Isthisanassaultorrobbery": "sample string",
			"Weretheresuspects": "sample string",
			"Werearrestsmade": "sample string",
			"Wasthereapolicereport": "sample string",
			"LossPreventionreport": "sample string",
			"Askthemtotakephotographs": "sample string",
			"Incidentlocationdiagrammade": "sample string", 
		},
	    "ProductLiability": {
            "IsthisclaimaProductLiabilityclaim": "Yes",
			"ProvideNameofProduct": "sample string",
			"ProvideProductCode": "sample string",
			"ManufacturersName": "sample string",
			"ManufacturerAddress1": "sample string",
			"ManufacturerAddress2": "sample string",
			"ManufacturerCity": "sample string",
			"ManufacturerState": "sample string",
			"ManufacturerPostalCode": "sample string",
			"ManufacturerPhone": "sample string",
			"Pleaseprovideadetaildescriptionoftheproduct": "sample string",
			"Wasstoreadvisedtoretaintheproduct": "sample string",
			"Isstoreincurrentpossessionofproduct": "sample string",
			"Briefdescriptionoffactsofloss": "sample string",
			"Responsibilityforroatingproduct": "sample string",
			"Didalocalvendorprovidethisproduct": "sample string",
			"VendorsName": "sample string",
			"VendorsPhoneNumber": "sample string"
        },
	    "MedicalInformation": {
     	   "WasindividualsenttoHospitalClinictoreceivemedicaltreatment": "yes",
			"HospitalClinicName": "sample string",
			"Address": "sample string",
			"City": "sample string",
			"State": "sample string",
			"Zip": "sample string",
			"PhoneNumber": "sample string",
			"Fax": "sample string",
			"ClinicDoctorName": "sample string"
	    },
	    "WitnessInformation": [{
			"ArethereanyWitnessesIdentified": "Yes",
			"NumberofWitnesses": 1
			},
			{
				"LastName": "sample string",
				"FirstName": "sample string",
				"MiddleName": "sample string",
				"PhoneNumber": "sample string",
				"Notes": "sample string"
				"Witness Relation to ProcessMAP(Coworkerfriendpublicsupervisorvenueemployee)": "sample string"
		}],
	    "ReportInformation": {
			"ReportedBy": "sample string",
			"Title": "sample string",
			"PhoneNumber": "sample string",
			"EmailAddress": "sample string"
		},
	    "AdditionalIncidentInformation": {
			"IncidentStatus": "sample string",
			"CreatedBy": "sample string",
			"CreatedDate": "2022-10-27T08:24:50.940Z",
			"LastUpdatedBy": "sample string",
			"LastUpdatedDate": "2022-10-27T08:24:50.940Z"
        }
    },
	"InvestigationReport": {
        "InvestigationResponsibility": {         
            "ResponsibleTeam": [{
                "Salutation": "sample string",
                "FirstName": "sample string",
                "LastName": "sample string"
            }],
            "TargetCompletionDate": "2020-04-30T00:00:00.000Z",
            "Note": null,
            "NotifyImmediateSupervisor": "Y"
        },  
        "InvestigationDetails": [],   
        "ContributingFactors": [{           
           "ContributingFactorType": "sample string",
           "ContributingFactors": 
           [
               "sample string"
           ],         
           "Comments": "sample string"
        }],        
        "5WhyMethodology": [{
            "SelectActionorConditionthatmayhavedirectlycausedincident": 
            [
                "Computer Theft"
            ],
            "5Whys": []
        }],
        "RootCauseStatement": [{
            "RootcauseType": "sample string",
            "RootCause": 
			[
			   "sample string"
			],
            "Comments": "sample string"
        }],
        "FinalRootCauseStatement": [{
           "FinalRootCauseStatement": "sample string",
           "PrimaryCountermeasure": "sample string",
           "PrimaryRootCause": "sample string"
        }]
    },     
    "ActionItems": [{
        "SourceID": "sample string",
        "SourceTitle": "sample string",
        "ActionItemTitle": "sample string",
        "ActionItemCategory": "sample string",
        "ActionItemType": "sample string",
        "ActionItemDescription": "sample string",
        "ActionItemPriority": "sample string",
        "ActionItemDueDate": "2020-04-16T00:00:00.000Z",
        "Owners": [
		   "sample string"
		],
        "ResponsibleDepartment": "sample string",
        "CounterMeasure": "sample string",
        "ApplicabletoExpansion": "sample string",
        "DescriptionofActionstobeExpanded": "sample string",
        "ApplicabletoEEMEPMInfo": "sample string",
        "EEMEPM": "sample string",
        "EEMEPMInfoSubmitted": "sample string",
        "DocumentNumber": "sample string",
        "AssignedBy": "sample string",
        "VerificationRequired": "sample string",
        "ActionItemStatus": "sample string",
        "ActionTaken": "sample string",
        "ActionItemCompletedBy": "sample string",
        "CompletedDate": null,
        "DueDateExtension": "sample string",
        "RequestedDueDateExtension": null,
        "ReasonforDueDateExtension": "sample string",
        "DueDateExtensionRequestApproved?": "sample string",
        "ReasonfornotextendingtheDueDate": "sample string"
    }],
	"ManagementReview": [
	{
        "RoleName": "sample string",
        "Owner": 
		 [
		    "sample string"
	     ],
        "approvalduedate": "2020-04-30T00:00:00.000Z",
        "Comments": "sample string",
        "CompletedByManagementReview": "sample string",
        "CompletedDate": ""
    },
    {
        "ManagementReviewStatus": "sample string"
    }
    ]
}]

JSON Field Mapping with respect to Application Fields :

JSON Field	ProcessMAP System Field
GeneralLiabilityIncidentDetails	General Liability Incident Details
IncidentID	Incident ID (System Generated)
InternalIncidentID
IncidentTitle	Incident Title/Site
IncidentType	Incident Type
LocationCode	Location Code
Location
GeneralDetails	General Details
WouldyouliketosubmitaGenarlLiabilityClaim	Would you like to submit a GeneralLiability Claim?
GeneralLiabilityType	General Liability Type
Sub-incidentType
DateOfIncident	Date of incident
TimeOfIncident	Time of incident
TimeUndetermined
DayOfWeek	Day Of Week
WorkShift	Job Shift
TimeWorkDayBegan	Time Work Day Began
DescriptionofIncident	Description of Incident
DateReportedtoEmployer	Date Reported to Employer
TimeReportedtoEmployer	Time Reported to Employer
WasAssetinvolved	Was Asset involved?
Assets	Select Asset(s)
Significance	Significance of Incident
PersonDetails	Person Details
WasEmployeeinvolvedintheIncident	Was an Employee / Individual involved in the Incident?
Numberofinvolvedindividuals	No. of individual involved
Name
Gender
DateOfBirth	Date Of Birth
HomeAddress	Home Address
City
State
Zip	ZipCode / PostalCode
PhoneNumber	Phone Number
Whatwaspersondoingbeforeincident	What was person doing before incident?
Wasindividualinjuredintheincident	Was individual injured in the incident?
DidInjuryresultinaFatality	Did Injury result in a Fatality?
ResultofIncident	Result of Incident
CauseofIncident	Cause of Incident
InjuredBodyPart	Injured Body Part
Pleasedescribepersoninjury	Please describe person injury
Waspersonconsideredminor	Was person considered minor?
Pleaseprovideparentsname	Please provide parents name
Pleaseprovideparentsphonenumber	Please provide parents phonenumber
Takenfromsceneviaambulance	Taken from scene via ambulance
Whatshoeswasclaimantwearing	What shoes was claimant wearing?
Wasclaimantstruckbyobject	Was claimant struck by object?
Ifstruckbyobjectwhatobject	If struck by object. what object?
Didthepersonrefusetreatment	Did the person refuse treatment?
IfYesexplainwhy	If Yes. explain why?
Wastreatmentprovided	Was treatment provided?
DidthepersonsignthemedicalreleaseformIfyespleaseattach	Did the person sign the medical release form ? If yes please attach.
WereEmergencyServicescalled	Were Emergency Services called?
EmployeeDetails	Employee / Individual Details
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
LocationOfIncident	Location of Incident
IncidentOccurredonEmployersPremises	Incident Occurred on Employers Premises
AddressofIncidentLocation	Address of Incident Location
City
Country
State
Zip	ZipCode / PostalCode
Department
PinLocation
LocationoftheIncident	Location of the Incident
StoreManagerName	Store Manager Name
StoreManagerPhone	Store Manager Phone
DistrictManagerName	District Manager Name
DistrictManagerPhone	District Manager Phone
Wasanythingonfloor	Was anything on floor?
Floorgroundscondition	Floor grounds condition
Incidentoccurinsideoutside	Incident occur inside/outside
Ifinsidestorewhere	If inside store where
IfInsidestorecause	If Inside store cause
IfinStockroomwhere	If in Stock room where
IfOutsidestorewhere	If Outside store where
IfOutsidestorecause	If Outside store cause
Istherevideooftheincident	Is there video of the incident
Ifvideonotobtainedwhy	If video not obtained why
IfEquipnotfunctionalwhy	If Equip not functional why
Didtheincidentresultinanydamagetocompanyequipment	Did the incident result in any damage to company equipment?
Pleasedescribeequipmentanddamage	Please describe equipment and damage
Didtheincidentresultinanystructuraldamage	Did the incident result in any structural damage
Pleasedescribedamage	Please describe damage
Wastheincidentareresultoftheftorasecurityrelatedactivity	Was the incident are result of the ftor a security related activity?
Pleasedescribetheftorsecurityrelatedincident	Please describe the ftor security related incident?
Isthisanassaultorrobbery	Is this an assault or robbery?
Weretheresuspects	Were there suspects?
Werearrestsuspects	Were arrest suspects?
Wastheapolicereport	Was the a police report?
LossPreventionreport	Loss Prevention report
Askthemtotakephotographs	Ask them to take photographs
Incidentlocationdiagrammade	Incident location diagram made
ProductLiability	Product Liability
IsthisclaimaProductLiabilityclaim	Is this claim a Product Liability claim?
ProvideNameofProduct	Provide Name of Product
ProvideProductCode	Provide Product Code
ManufacturersName	Manufacturer's Name
ManufacturerAddress1	Manufacturer Address1
ManufacturerAddress2	Manufacturer Address2
ManufacturerCity	Manufacturer City
ManufacturerState	Manufacturer State
ManufacturerPostalCode	Manufacturer Postal Code
ManufacturerPhone	Manufacturer Phone
Pleaseprovideadetaildescriptionoftheproduct	Please provide a detail description of the product
Wasstoreadvisedtoretaintheproduct	Was store advised to retain the product?
Isstoreincurrentpossessionofproduct	Is store in current possession of product?
Briefdescriptionoffactsofloss	Brief description of facts of loss
Responsibilityforroatingproduct	Responsibility for roating product
Didalocalvendorprovidethisproduct	Did a local vendor provide this product?
VendorsName	Vendor's Name
VendorsPhoneNumber	Vendor's Phone Number
MedicalInformation
WasindividualsenttoHospitalClinictoreceivemedicaltreatment	Was individual sent to Hospital/Clinic to receive medical treatment
HospitalClinicName	Hospital/ClinicName
Address
City
State
Zip
PhoneNumber	Phone Number
Fax
ClinicDoctorName	Clinic/DoctorName
WitnessInformation	Witness Information
ArethereanyWitnessesidentified	Are there any Witnesses identified
NumberofWitnesses	Number of Witnesses
LastName	LastName
FirstName	FirstName
MiddleName	MiddleName
Notes	Notes
PhoneNumber	Phone Number
Witness Relation to ProcessMAP	Relationship
ReportInformation
ReportedBy	Reported By
Title	Title
PhoneNumber	Phone Number
EmailAddress	Email Address
InvestigationResponsibility	Investigation Responsibility
Salutation	Salutation
FirstName	First Name
LastName	Last Name
TargetCompletionDate	Target Completion Date
Note	Note
NotifyImmediateSupervisor	Notify Immediate Supervisor
InvestigationDetails	Investigation Details
All questions
ContributingFactors	Contributing Factors
ContributingFactorType	Contributing Factor Type
ContributingFactors	Contributing Factors
Comments	Comments
5WhyMethodology	5 Why Methodology
SelectActionorConditionthatmayhavedirectlycausedincident	Select Action or Condition that may have directly caused incident
Whys	Whys
RootCauseStatement	Root Cause Statement
RootcauseType	Root cause Type
RootCause	Root Cause
Comments	Comments
FinalRootCauseStatement	Final Root Cause Statement
FinalRootCauseStatement	Final Root Cause Statement
PrimaryCountermeasure	Primary Counter measure
PrimaryRootCause	Primary Root Cause
ActionItems	Action Items
SourceID	Source ID
SourceTitle	Source Title
ActionItemTitle	Action Item Title
ActionItemCategory	Action Item Category
ActionItemType	Action Item Type
ActionItemDescription	Action Item Description
ActionItemPriority	Action Item Priority
ActionItemDueDate	Action Item Due Date
Owners
ResponsibleDepartment	Responsible Department
Countermeasure	Countermeasure
ApplicabletoExpansion	Applicable to Expansion?
DescriptionofActionstobeExpanded	Description of Actions to be Expanded *
ApplicabletoEEMEPMInfo	Applicable to EEM/EPM Info?
EEMEPM	EEM / EPM *
EEMEPMInfoSubmitted	EEM/EPM Info Submitted?
DocumentNumber	Document Number *
AssignedBy	Assigned By
Verificationrequired	Verification required
ActionItemStatus	Action Item Status
ActionTaken	Action Taken
ActionitemCompletedBy	Action item Completed By
CompletedDate	Action item Completed Date
DueDateExtension	Due Date Extension
RequestedDueDateExtension	Requested Due Date Extension
ReasonforDueDateExtension	Reason for Due Date Extension
DueDateExtensionRequestApproved	Due Date Extension Request Approved?
ReasonfornotextendingtheDueDate.	Reason for not extending the DueDate.
ManagementReview	Management Review
RoleName	Role Name
Owner
approvalduedate	approval due date
Comments
CompletedByManagementReview	Completed By Management Review
CompletedDate	Completed Date
ManagementReviewStatus	Management Review Status
Additional Information
IncidentStatus	Incident Status
CreatedBy	Created By
CreatedDate	Created Date
LastUpdatedDate	Last Updated Date
LastUpdatedBy	Last Updated By

Ideagen EHS Help Site