Background and strategic fit
The purpose of this Integration is to pull over different incident information (Near Miss and Injury Illness) 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
- Individual APIs being used for Injury & Claim and Near Miss
- For Injury/Illness the Incident type field will have comma separate value in case it is a combined Incident with other Incident Types
- Data will be sent only for the Injury/Illness
- 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 would be Product Field Naming. Customer will have to use mapping documentation
- 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
- BodyParts -- Will be separated by , and side will be mentioned in braces Ex: Arm (L)(R)
- For Nature, Cause and BodyParts -- IF Other(List) is selected then others description will be appended with '-' Ex: Other(List) --- Some Text
- For Employee, Supervisor, Reported By -- LastName, MiddleName, First name and Prefix will be combined as shown as single (Prefix(if available) + Firstname+ MiddleName(if available) + LastName)
- For Witness the First Name, Middle Name, Last Name will not be appended as no field is mandatory
- Incident Status will be included in the json output
- DATETIME, INT and FLOAT data will be shown as NULL when there is no data
- Pin Location Information and Default CAPA is not considered for this release
- 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
Near Miss
Incident Details
Request
Ex: papi/v1/imsoutbound/nearmissincidents?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:
{
"Incident ID (System Generated)": "sample string",
"Incident Title/Site": "sample string",
"Location Code": "sample string",
"Location": "sample string",
"Incident Date": "2019-10-06T00:00:00.000Z",
"Time of Incident": "sample string 2",
"Time Undetermined": "sample string",
"Date Reported to Employer": "2019-10-06T00:00:00.000Z",
"Time Reported To Employer": "18:40",
"Day Of Week": "sample string",
"Reported By": "sample string",
"Work Shift": "sample string",
"Incident Occurred on Employer's Premises": "sample string",
"Operating Unit": "sample string",
"Describe what occurred to create the Near Miss/Unsafe Act/Unsafe Condition?": "sample string.",
"Is Contractor Involved?": "sample string",
"Please provide Contractor Name, Company": "sample string",
"Near Miss Incident Type": "sample string",
"Severity": "sample string",
"Hazard Classification": "sample string",
"Potential Injury / Illness":
[
{
"Nature of Injury / Illness": "sample string",
"Cause of Injury/Illness": "sample string",
"Injured Body Parts":
[
"sample string",
"sample string",
]
}
],
"Employee/Individual Details":
{
"Was an Employee / Individual involved in the Incident?": "sample string",
},
"Are there any Witnesses identified?": "sample string",
"If Yes - Number of Witnesses": "sample string",
"Witness Information":
[ {
"LastName": "sample string 2",
"FirstName": "sample string 3",
"MiddleName": "sample string 4",
"PhoneNumber": "sample string 5",
"Notes": "sample string 6"
} ],
"Incident Status": ""sample string",
"Created By": "sample string",
"Created Date": "2019-10-14T11:43:31.517Z",
"Modified Date": "2019-10-14T11:47:29.440Z",
"Modified By": "sample string",
"Investigation Responsibility":
{ "Responsible Team": [ { "Salutation": null, "First Name": "John", "Last Name": "Smith" }, { "Salutation": null, "First Name": "Sagar", "Last Name": "Pradhan" } ], "Target Completion Date": "2019-11-22T00:00:00.000Z", "Note/Comments": "Test inv responsblity*", "Notify Immediate Supervisor": "Y" },
"Investigation Details": [
{
"Had the job or task related to the Near Miss been risk assessed?": "sample string",
"IF No, explain:":"sample string",
},
{
"Was incident reviewed with the involved employee?":"sample string",
"Employee Comments (If yes to answer above)": "sample string",
},
{
"How long has the employee been working on the job where the Near Miss occurred?": "sample string"
},
{
"Was the employee performing their normal job?": "sample string"
},
{
"Select the type of the task the employee was performing when the Near Miss occurred": "sample string"
},
{
"What tools, machine, equipment, object, or substances or components were involved in the Near Miss": "sample string"
},
{
"Lessons Learned from incident to be communicated to other departments?": "sample string"
},
"Name of person leading the investigation": "sample string"
},
{
"Investigation completed date": "sample string"
},
{
"Investigation completed Time": "sample string"
},
{
"Name of representative(s) approving of the investigation and corrective action?": "sample string"
},
{
"Date of representaive(s) approval": "sample string"
}
],
"Contributing Factors":
[
{
"Contributing Factor Type (Parent)": "sample string",
"Contributing Factors":
[
"sample string",
"sample string"
],
"Comments": "sample string"
}
],
"5 Why? Methodology":
[
{
"Select Action or Condition that may have directly caused incident":
[
"sample string"
],
"Whys":
[
{
"Why or what created the scenario above to affect the action or condition": "sample string"
},
{
"Final Root Cause Checked": "sample string"
}
]
],
"Root Cause Analysis":
[
{
"Root cause Type (Parent)": "sample string",
"Root Cause":
[
"Tools/Equipment - "sample string",
],
"Comments": "sample string"
}
],
"Action Items": [
{
"Source ID": "sample string",
"Source Title": "sample string",
"Action Item Title": "sample string",
"Action Item Category": "Incident Management",
"Action Item Type": "Corrective Action",
"Action Item Description":"sample string",
"Action Item Priority": "sample string",
"Action Item Due Date": "2019-11-06T00:00:00.000Z",
"Owners":
[
"sample string"
],
"Responsible Department": "sample string",
"Applicable to Expansion": "sample string",
"Description of Actions to be Expanded": "sample string",
"Applicable to EEM/EPM Info": "sample string",
"EEM / EPM":"sample string",
"EEM/EPM Info Submitted": "sample string",
"Document Number": "sample string",
"Assigned By": "sample string",
"Verification Required": "sample string",
"Action Item Status": "sample string",
"Action Taken": "sample string",
"Action Item Completed By": "sample string",
"Completed Date": "2019-10-06T00:00:00.000Z",
"Due Date Extension": "sample string",
"Requested Due Date Extension": "sample string",
"Reason for Due Date Extension": "sample string",
"Due Date Extension Request Approved?": "sample string",
"Reason for not extending the Due Date": "sample string",
"Verification Status": "sample string",
"Verification Performed": "sample string",
"Verified By": "sample string"
"Verification Date":"sample string"
"Comments":"sample string",
}
]
Near Miss Field List
Section | Field Name | Database Column Size |
---|---|---|
Incident Detail | ||
Incident ID * | NVARCHAR(400) | |
Internal incident Id | NVARCHAR(200) | |
Incident Title (No Personal data to be entered) * | NVARCHAR(400) | |
General Detail | ||
Incident Date * | DATETIME | |
Time of Incident * | NVARCHAR(100) | |
Time Undetermined | NVARCHAR(10) | |
Day of Week * | NVARCHAR(50) | |
Date Reported to Employer | DATETIME | |
Time Reported to Employer | NVARCHAR(200) | |
Reported By | NVARCHAR(200) | |
Work Shift * | NVARCHAR(200) | |
Incident Occurred on Employer's Premises * | NVARCHAR(3) | |
Address of Incident Location * | NVARCHAR(500) | |
City * | NVARCHAR(50) | |
County | NVARCHAR(50) | |
Country * | NVARCHAR(50) | |
State * | NVARCHAR(50) | |
Postal Code | NVARCHAR(50) | |
Department * | NVARCHAR(100) | |
Department where the incident/injury occurred | NVARCHAR(100) | |
Could this have resulted in a life altering injury or fatality? * | NVARCHAR(100) | |
Describe what occurred to create the Near Miss? * | NVARCHAR(8000) | |
Is Contractor Involved? * | NVARCHAR(50) | |
Please provide Contractor Name, Company * | NVARCHAR(500) | |
Nearmiss Incident type * | NVARCHAR(200) | |
Severity * | NVARCHAR(50) | |
Hazard Classification * | NVARCHAR(100) | |
Was a Corrective Action completed at time of reporting incident? | NVARCHAR(3) | |
Action Item Title | NVARCHAR(500) | |
Action Taken | NVARCHAR(4000) | |
Primary Owners | NVARCHAR(100) | |
Assigned By | NVARCHAR(100) | |
Completion Date | DATETIME | |
Potentially Injury illness section | ||
Nature of Illness/Injury * | NVARCHAR(100) | |
Cause of Illness/Injury * | NVARCHAR(200) | |
Injured Body Part | NVARCHAR(100) | |
Employee / Individual Details | ||
Was an Employee / Individual involved in the Incident? * | NVARCHAR(50) | |
Personnel Type * | NVARCHAR(50) | |
Employee / Individual Involved ( Last, First, M.I.) * | NVARCHAR(200), NVARCHAR(200), NVARCHAR(200) | |
Employee Id * | NVARCHAR(200) | |
Gender | NVARCHAR(200) | |
Occupation/Job Title | NVARCHAR(200) | |
Hire Date | DATETIME | |
Employee / Individual Department | NVARCHAR(100) | |
Supervisor ( Last, First, M.I) | NVARCHAR(200), NVARCHAR(200), NVARCHAR(200) | |
Supervisor's Email | NVARCHAR(50) | |
Do you want to further classify Unsupervised Contract Employee | NVARCHAR(10) | |
Type of Client Personnel | NVARCHAR(20) | |
Client Company | NVARCHAR(100) | |
Name of Contractor | NVARCHAR(800) | |
Name of Sub-Contractor | NVARCHAR(800) | |
Witness Information | ||
Are there any Witness identified? | NVARCHAR(20) | |
If Yes - Number of Witnesses | INT | |
Last Name | NVARCHAR(50) | |
First Name | NVARCHAR(50) | |
Middle Name | NVARCHAR(50) | |
Phone Number | NVARCHAR(100) | |
Notes | NVARCHAR(2000) |
Injury/Illness
Incident Details
Request
GET papi/v1/imsoutbound/injuryincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}
Ex: papi/v1/imsoutbound/injuryincidents?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. | 2222 |
Sample Response:
[
{
"Injury/Illness Incident Detail": {
"Incident Details": {
"Incident ID": "sample",
"Incident Title/Site": "sample",
"Incident Type": "sample",
"Location Code": "sample",
"Location": "sample",
"Were multiple people injured as part of this incident?": "sample"
},
"General Details": {
"Date of Incident": "sample"
"Time of Incident": "sample",
"Time Undetermined": "sample",
"Day Of Week": "sample",
"Work Shift": "sample",
"Time Work Day Began": "sample",
"Description of Incident": "sample",
"Incident Occurred on Employer's Premises": "sample",
"Department": "sample",
"Location of Injury Scene": "sample"
},
"Employee / Individual Details": [
{
"Personnel Type": "sample",
"Employee": {
"Last Name": "sample",
"First Name": "sample",
"Middle Name": "sample",
"Salutation": "sample"
},
"Employee ID": "sample",
"Gender": "sample",
"Occupation/Job Title": "sample",
"Hire Date": "sample",
"Employee / Individual Department": "sample",
"Supervisor (Last,First,MI)": {
"Last Name": "sample",
"First Name": "sample",
"Middle Name": "sample"
},
"Supervisor's Email": "sample"
}
],
"Injury/Illness Summary": [
{
"Was employee taken offsite for evaluation by a medical professional?": "sample",
"Did this incident involve an in-patient hospitalization, amputation, or a loss of an eye?": "sample",
"Has OSHA been contacted?": "sample",
"Please Identify OSHA Contact Details ”Name and Phone Number”": "sample",
"Nature of Injury / Illness": "sample",
"Cause of Injury/Illness": "sample",
"Injured Body Parts": [
"Finger(s) (L)"
],
"What was the employee doing just before the incident occurred?": "sample",
"Please describe what object or substance directly harmed the employee?.If this question does not apply, enter “not applicable”?": "sample",
"Machine/Equipment Number": "sample",
"Type": "sample",
"Brand": "sample",
"Model": "sample"
}
],
"Witness Information": {
"Are there any Witnesses identified?": "sample",
"Number of Witnesses": 1,
"Witness Information": [
{
"First Name": "sample",
"Middle Name": "sample",
"Last Name": "sample",
"Phone Number": "sample",
"Notes": "sample"
}
]
},
"Additional Incident Information": {
"Incident Status": "sample",
"Created By": "sample",
"Created Date": "sample",
"Last Updated By": "sample",
"Last Updated Date": "sample"
}
},
"Case Management": {
"Classification of Case": [
{
"Case Number": "sample",
"Was this case Work-Related?": "sample",
"Describe the reason for the \"Non Work Related\" classification": "sample",
"Did this incident result in a fatality?": "sample",
"Did this incident result in an amputation, fractured/cracked bone(s) (including teeth), or loss of consciousness?": "sample",
"Did the incident result in work restrictions, lost time or job transfer?": "sample",
"Was Treatment Provided beyond First Aid? (Prescription strength medications, Application of wound closing devices, Intravenous Fluids)": "sample",
"Did the injury involve a needlestick and cut(s) from sharp objects that are contaminated with another person's blood or other potentially infectious material?": "sample",
"Was treatment defined as \"First Aid\" provided?": "sample",
"This is a First Aid Case, identify the specific treatment(s) provided": "sample",
"Is This a Bunge (US OSHA) defined Recordable Case ?": "sample",
"Describe the reason for the \"Not Recordable\" classification": "sample",
"Is this Case Recordable According to Local Record keeping Requirements ?": "sample",
"Case Status": "sample",
"Comments": "sample",
"Completed By": "sample",
"Title": "sample",
"Phone": "sample"
}
],
"Case Classification and Progress Tracking": {
"Other Recordable/MAA": [
{
"Employee Name": "sample",
,
"Classification of Case": "sample",
"Date Other Recordable/MAA Case Occurred": "sample",
"Reason for Classification": "sample",
"Comments": "sample",
"Official Medical Diagnosis (Nature of Injury / Illness)": "sample",
"Was Treatment provided offsite?": "sample",
"Hospital / Clinic Name": "sample",
"Type": "sample",
"Physician/Healthcare Provider": "sample",
"Street": "sample",
"City": "sample",
"Country": "sample",
"State": "sample",
"Postal Code/Zip Code": "sample",
"Phone": "sample",
"Fax": "sample",
"Was the employee treated in an emergency room": "sample",
"Was employee hospitalized overnight as an in-patient": "sample",
"Recording/Revision Date": "sample"
}
]
}
},
"Claim": {
"Claim Information": [
{
"Do you want to file a claim for this incident?": "sample",
"Worker's Comp ID": "sample",
"Workers Comp Claim#": "sample",
"Incident Reported By": "sample",
"Reporter's Email": "sample",
"Reporter's Phone": "sample",
"Injury Date": "sample",
"Injury Day of Week": "sample",
"Time of Injury": "sample",
"Time Workday (Shift) Began": "sample",
"Incident id/Case No": "sample",
"Is this Claim work related?": "sample",
}
],
"Employee/Individual Details": [
{
"Employee Name First": "sample",
"Middle": "sample",
"Last": "sample",
"Home Address:Street": "sample",
"City": "sample",
"State": "sample",
"Zip": "sample",
"Home Phone Number": "sample",
"Gender": "sample",
"Date of Birth": "sample",
"Marital Status": "sample",
"Hire Date": "sample",
"Years at Bunge": "sample",
"Number of Dependants": 2,
"Type of Employment": "sample",
"Occupation": "sample",
"Department Name": "sample",
"State Hired": "sample",
"Supervisor Name": "sample",
"Supervisor Phone": "sample",
"Current Weekly Wage": "sample",
"Hourly Wage": "sample",
"Hours worked per Week": "sample",
"Days worked Per Week": "sample",
"Hours worked Per Day": "sample",
"Employment Status": "sample",
"Employee ID Number": "sample",
"Was Employee Paid in Full for Date of Injury": "sample",
"Any Prior WC Injuries": "sample",
"OSHA Reference No.": "sample",
"Will employee's salary continue?": "sample",
}
],
"Employer Information": [
{
"Health & Safety / WC Contact Name": "sample",
"Telephone Number": "sample",
"Title": "sample",
"Mailing Address": "sample",
"City": "sample",
"State": "sample",
"Zip": "sample",
"Employer Location Code": "sample",
"Employer SIC": "sample",
"Nature of Business": "sample",
"Employer Name": "sample"
}
],
"Accident Information": [
{
"Did the Accident Occur at the Work Location?": "sample",
"If no , where did the accident occur? Accident Address": "sample",
"City": "sample",
"State": "sample",
"Zip": "sample",
"Give a full Description of the Accident: (Be as Complete as Possible)": "sample",
"What was the employee doing just before the incident occurred?": "sample",
"Please describe what object or substance directly harmed the employee?": "sample",
"Jurisdiction State": "sample",
"Date and Time Reported to Employer": "sample",
"Hours: Minutes": "sample"
}
],
"Injury Information": [
{
"Did incident result in a fatality?": "sample",
"Date fatality occurred": "sample",
"Did the employee lose any time from work?": "sample",
"What was the first full day out": "sample",
"Do you know the Date Employee Last Worked?": "sample",
"Date Employee Last Worked": "sample",
"Has the employee returned to work?": "sample",
"Date Returned to Work": "sample",
"Return to Work Status": "sample",
"Estimated return to work date": "sample",
"Nature of Injury": "Cut / "sample",
"Cause of Injury/illness": "sample",
"Which Part of the Body was Injured?": [
"Finger(s)(L)"
],
"Part of the Body Location?": "sample",
"Needle Stick Injury": "sample",
"Reqs Sharps Inj Log": "sample"
}
],
"Medical Information": [
{
"Was employee sent to Hospital / Clinic to receive Medical Treatement?": "sample",
"Initial Medical Treatment": "sample",
"Hospital / Clinic Name": "sample",
"Address": "sample",
"City": "sample",
"State": "sample",
"Zip": "sample",
"Phone": "sample",
"Fax": "sample",
"Clinic/Doctor Name": "sample"
}
],
"Witness Information": [
{
"Were There Any Witnesses?": "sample",
"If Yes, Name": "sample",
"Contact": "sample"
}
],
"Additional Comments and Information": [
{
"Do you question the validity of the claim": "sample",
"If yes, provide Details": "sample",
"Other Comments": "sample"
}
],
"Report Prepared By": [
{
"Name": "sample",
"Title": "sample",
"Phone": "sample"
}
]
},
"Investigation Report": {
"Investigation Responsibility": { },
"Investigation Details": [
{
"Is this an Ergonomic injury?": "sample"
},
{
"Description of incident (please maintain in local language if other than English)": "sample"
},
{
"Is this an HPE incident?": "sample",
"Please select Non-HPE Type": "sample",
"HPE Type": "sample"
},
{
"Task at time of incident": "sample",
},
{
"Did incident interrupt normal operations?": "sample",
"Length of Downtime": "sample",
"Describe interruption:": "sample"
},
{
"Was it necessary to retain items involved with this incident? (tools, equipment, etc.)": "sample",
"If yes, please list items retained and current location": "sample"
},
{
"Were Local or Government Authorities contacted as a result of this incident?": "sample",
"Which agencies were contacted?": {
"Which agencies were contacted?": "sample",
"Please specify": "sample"
}
},
{
"Post Accident: Drug/Alcohol Screen Conducted": "sample"
},
{
"Date Reported to Management": "sample"
},
{
"Time Reported to Management": "sample"
},
{
"Length of Normal Workday": "sample"
},
{
"length of employment at current position": "sample"
},
{
"length of employment at current position Unit": "Years"
},
{
"Was any Machine / Equipment involved?": "sample",
"Machine/Equipment Number": "sample"
},
{
"Specific Work Activity when the incident occurred": "sample",
"Please specify:": "sample"
}
],
"Ergonomic Analysis": [ ],
"Contributing Factor/Immediate Cause": [
{
"Contributing Factor Type (Parent)": "sample",
"Contributing Factor/Immediate Cause": [
"sample"
],
"Comments": "sample"
},
{
"Contributing Factor Type (Parent)": "sample",
"Contributing Factor/Immediate Cause": [
"sample"
],
"Comments": "sample"
}
],
"5 Why? Methodology": [
{
"Select Action or Condition that may have directly caused incident": [
"sample"
],
"Whys": [
{
"Why or what created the scenario above to affect the action or condition": "sample"
},
{
"Final Root Cause/Basic Cause Checked": "sample"
}
]
},
{
"Select Action or Condition that may have directly caused incident": [
"sample"
],
"Whys": [
{
"Why or what created the scenario above to affect the action or condition": "sample"
},
{
"Final Root Cause/Basic Cause Checked": "sample"
}
]
}
],
"Root Cause/Basic Cause Analysis": [
{
"Root cause Type (Parent)": "sample",
"Root Cause/Basic Cause": [
"sample"
],
"Comments": "sample"
}
],
"Lessons Learned": [
{
"Lessons Learned": "sample"
}
]
},
"Action Items": [
{
"Source ID": "sample",
"Source Title": "sample",
"Action Item Title": "sample",
"Action Item Category": "Incident Management",
"Action Item Type": "Corrective Action",
"Action Item Description": "sample",
"Action Item Priority": "High",
"Action Item Due Date": "sample",
"Owners": [
"sample"
],
"Assigned By": "sample",
"Verification Required": "sample",
"Action Item Status": "sample",
"Action Taken": "sample",
"Action Item Completed By": "sample",
"Completed Date": "sample",
"Due Date Extension": "sample",
"Requested Due Date Extension": "sample",
"Reason for Due Date Extension": "sample",
"Due Date Extension Request Approved?": "sample",
"Reason for not extending the Due Date": "sample"
}
]
}
]
Injury/Illness and Claim Field List
Section | Field Name | Database Column Size |
---|---|---|
Incident Detail | ||
Incident ID * | NVARCHAR(400) | |
Internal Incident ID | NVARCHAR(200) | |
Incident Title/Site* | NVARCHAR(400) | |
Incident Type * | INT | |
Were multiple people injured as part of this incident? | NVARCHAR(50) | |
General Details | ||
Is this a MSHA Related Incident*? | NVARCHAR(100) | |
Date of Incident * | DATETIME | |
Time of Incident * | NVARCHAR(100) | |
Time undetermined | NVARCHAR(10) | |
Day Of Week ** | NVARCHAR(100) | |
Length of Normal Workday | NVARCHAR(100) | |
Work Shift ** | INT | |
Time Work Day Began ** | NVARCHAR(200) | |
Description of Incident * | NVARCHAR(8000) | |
Incident Occurred on Employer's Premises * | NVARCHAR(6) | |
Address of Incident Location * | NVARCHAR(1000) | |
City * | NVARCHAR(100) | |
County | NVARCHAR(100) | |
Country * | NVARCHAR(100) | |
State/Province * | NVARCHAR(100) | |
Postal Code/Zip Code | NVARCHAR(100) | |
Department * | INT | |
Department where the incident/injury occurred | INT | |
Location of Injury Scene | NVARCHAR(1000) | |
Date and Time Reported to Employer | DATETIME | |
NVARCHAR(200) | ||
Confirm Significance level of incident | INT | |
Employee / Individual Details | ||
Would you like to submit a Workers Compensation claim? * | NVARCHAR(100) | |
Personnel Type * | INT | |
Employee / Individual Involved ( Last, First, M.I.) * | NVARCHAR(200), NVARCHAR(200), NVARCHAR(200) | |
Employee Id * | NVARCHAR(200) | |
Employee's Social Security Number ** | NVARCHAR(200) | |
Date of Birth ** | datetime | |
Gender ** | NVARCHAR(200) | |
Occupation/Job Title ** | NVARCHAR(200) | |
Hire Date ** | DATETIME | |
Time in Current job | INT | |
Employee / Individual Department | INT | |
Supervisor ( Last, First, M.I) | INT | |
Supervisor's Email | NVARCHAR(50) | |
Supervisor Phone | NVARCHAR(50) | |
Home Address | NVARCHAR(500) | |
City | NVARCHAR(50) | |
State | NVARCHAR(50) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Home Phone Number | NVARCHAR(50) | |
Marital Status | NVARCHAR(50) | |
Years at "Company" | NVARCHAR(50) | |
Number Of Dependents | INT | |
Type of Employment | NVARCHAR(100) | |
Current Weekly Wage | FLOAT | |
Hourly Wage | FLOAT | |
Hours Worked per Week | FLOAT | |
Days worked Per Week | INT | |
Hours worked Per Day | INT | |
State Hired | NVARCHAR(50) | |
Employment Status | NVARCHAR(50) | |
Was Employee Paid in Full for Date of Injury? | NVARCHAR(50) | |
Any Prior WC Injuries? | NVARCHAR(50) | |
Do you want to further classify Unsupervised Contract Employee | NVARCHAR(50) | |
Type of Client Personnel | NVARCHAR(20) | |
Client Company | NVARCHAR(100) | |
Name of Contractor | NVARCHAR(800) | |
Name of Sub-Contractor | NVARCHAR(800) | |
Will employee's salary continue? | NVARCHAR(50) | |
Injury/Illness Summary | ||
Was Employee treated offsite? ** | NVARCHAR(50) | |
Where was employee treated | NVARCHAR(1000) | |
Explain Why | ||
If this injury had occurred in a slightly different matter, could it have caused a serious injury or fatality | ||
Did this incident involve an in-patient hospitalization, amputation, or a loss of an eye? | ||
Has OSHA been contacted? | ||
Please Identify OSHA Contact Details (Name and Phone Number) | ||
Nature of Injury / Illness ** | INT | |
Cause of Illness/Injury ** | INT | |
Injured Body Part ** | INT | |
What was the employee doing just before the incident occurred? * | NVARCHAR(4000) | |
Please describe what object or substance directly harmed the employee? If this question does not apply, enter “not applicable” ** | NVARCHAR(MAX) | |
Specific Work Activity when the incident occurred | NVARCHAR(4000) | |
Was any Machine / Equipment involved? | NVARCHAR(4000) | |
Machine/Equipment Number | NVARCHAR(100) | |
Reviewed by EHS Representative | NVARCHAR(4000) | |
Review Date | DATETIME | |
Is this a Needlestick Injury? | VARCHAR(50) | |
Type | NVARCHAR(100) | |
Brand | NVARCHAR(100) | |
Model | NVARCHAR(100) | |
Identify Initial Treatment | INT | |
Was Drug Testing Performed? | NVARCHAR(10) | |
Explain Why | [NVARCHAR](1000) | |
RIDDOR Classification | ||
RIDDOR Classification | INT | |
Employer Information | ||
Health & Safety / WC Contact Name | NVARCHAR(50) | |
Telephone Number | NVARCHAR(50) | |
Title | NVARCHAR(50) | |
Mailing Address | NVARCHAR(500) | |
City | NVARCHAR(50) | |
State | NVARCHAR(20) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Employer Location Code | NVARCHAR(50) | |
Employer SIC | NVARCHAR(50) | |
Nature of Business | NVARCHAR(500) | |
Employer FEIN Number | NVARCHAR(20) | |
Employer Name | NVARCHAR (100) | |
Injury Information | ||
Workers Comp Claim# | NVARCHAR(50) | |
Is This Claim Work Related | NVARCHAR (50) | |
Jurisdiction State | NVARCHAR (100) | |
Did the incident result in fatality? | NVARCHAR(50) | |
Date fatality occurred | DATETIME | |
Did the employee lose any time from work? | NVARCHAR(50) | |
What was the first full day out? | DATETIME | |
Do you know the Date Employee Last Worked? | NVARCHAR(50) | |
Date Employee Last Worked | DATETIME | |
Has the employee returned to work? | NVARCHAR(50) | |
Date Returned to Work | DATETIME | |
Return to Work Status | NVARCHAR(50) | |
Estimated Return to Work Date | DATETIME | |
Reqs Sharps Inj Log | NVARCHAR(50) | |
Medical Information | ||
Was employee sent to Hospital / Clinic to receive Medical Treatment? ** | NVARCHAR(50) | |
Initial Medical Treatment | NNVARCHAR(50) | |
Hospital / Clinic Name | NVARCHAR(500) | |
Address | NVARCHAR(500) | |
City | NVARCHAR(50) | |
State | NVARCHAR(50) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Fax | NVARCHAR(50) | |
Clinic/Doctor Name | NVARCHAR(50) | |
Additional Comments and Information | ||
Do you question the Validity of the claim? | NVARCHAR(50) | |
Provide details | NVARCHAR(500) | |
Other Comments | NVARCHAR(500) | |
Additional Claim Information | ||
Claim Form Completed | NVARCHAR(100) | |
Claim Submission Status | NVARCHAR(200) | |
Claim Submitted By | NVARCHAR(200) | |
Claim Submitted Date | DATETIME | |
Claim Status | NVARCHAR(100) | |
Date Claim Closed | DATETIME | |
Total Cost Incurred | FLOAT | |
Total Cost Paid | FLOAT | |
Total Outstanding Cost | FLOAT | |
Total Developed Cost | FLOAT | |
Witness Information | ||
Are there any Witnesses identified? | NVARCHAR(20) | |
Number of Witnesses | INT | |
Last Name | NVARCHAR(50) | |
First Name | NVARCHAR(50) | |
Middle Name | NVARCHAR(50) | |
Phone Number | NVARCHAR(100) | |
Notes | NVARCHAR(2000) | |
Witness relation to <CUSTOMER> Coworker, friend, public, supervisor, venue employee | NVARCHAR(500) | |
Report Prepared By: | ||
Name | NVARCHAR(50) | |
Title | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Additional Incident Information | ||
Incident Status | NVARCHAR(100) | |
Created By | NVARCHAR(100) | |
Created Date | DATETIME | |
Last Updated By | NVARCHAR(100) | |
Last Updated Date | DATETIME |
Case Management Field List
Section | Field Name | Database Column Size |
---|---|---|
Classification Of Case | ||
Case Number | NVARCHAR(500) | |
Was this case Work-Related? | NVARCHAR(50) | |
Describe the reason for the "Non Work Related" classification | NVARCHAR(1000) | |
Did this incident result in a fatality? | NVARCHAR(100) | |
Did this incident result in an amputation, fractured/cracked bone(s) (including teeth), or loss of consciousness? | NVARCHAR(100) | |
Did the incident result in work restrictions, lost time or job transfer? | NVARCHAR(100) | |
Was Treatment Provided beyond First Aid? (Prescription strength medications, Application of wound closing devices, Intravenous Fluids). | NVARCHAR(100) | |
Did the injury involve a needlestick and cut(s) from sharp objects that are contaminated with another person's blood or other potentially infectious material? | NVARCHAR(100) | |
Was treatment defined as "First Aid" provided? | NVARCHAR(100) | |
This is a First Aid Case, identify the specific treatment(s) provided. | INT | |
Is This a Company defined Recordable Case ? | NVARCHAR(50) | |
Describe the reason for the "Not Recordable" classification | NVARCHAR(500) | |
Is this Case Recordable According to Local Recordkeeping Requirements? | NVARCHAR(50) | |
Does this meet FCA's requirement for FAI classification | NVARCHAR(50) | |
Did this case involve a chronic injury, a strain or a sprain? * | NVARCHAR(50) | |
Date reported to Health Care Center | DATETIME | |
Time reported to Health Care Center | NVARCHAR(50) | |
Case Status | NVARCHAR(50) | |
Date | DATETIME | |
Comments/Notes | NVARCHAR(MAX) | |
Completed By | INT | |
Title | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Case Progression Tracking | ||
Employee Name | NVARCHAR(200) | |
Classification of Case | NVARCHAR(50) | |
Date Reported | DATETIME | |
Date First Aid Provided | DATETIME | |
Date other Recordable case Occurred | DATETIME | |
First Day of Restricted Duty | DATETIME | |
Last Day of Restricted Duty | DATETIME | |
First Day of Lost Time | DATETIME | |
Last Day of Lost Time | DATETIME | |
Date Fatality Occurred | DATETIME | |
Reason for Classification | NVARCHAR(500) | |
Reason for Classification | NVARCHAR(500) | |
Is This A Defense Based Act Case? | NVARCHAR(50) | |
Is This A Compensable Case? | NVARCHAR(50) | |
Comments/Notes | NVARCHAR(500) | |
Official Medical Diagnosis (Nature of Injury / Illness) | NVARCHAR(100) | |
Was the Corporate Medical Director contacted? | NVARCHAR(50) | |
Was medical Treatment Rejected? | NVARCHAR(50) | |
Reason for Refusal | NVARCHAR(500) | |
Was Treatment Provided beyond First Aid?(Prescription strength medications, Application of wound closing devices, Intravenous Fluids) | NVARCHAR(50) | |
Was Treatment provided offsite? | NVARCHAR(10) | |
Hospital/Clinic Name | NVARCHAR(500) | |
Type | NVARCHAR(50) | |
Physician/Health care Provider | NVARCHAR(50) | |
Street | NVARCHAR(200) | |
City | NVARCHAR(100) | |
Country | INT | |
State | NVARCHAR(50) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Fax | NVARCHAR(100) | |
Was the employee treated in an emergency room | NVARCHAR(50) | |
Was employee hospitalized overnight as an in-patient | NVARCHAR(50) | |
Recording/Revision Date | DATETIME |
Investigation Sections Field List (Common to All Incident Types)
Section | Field Name | Database Column Size |
---|---|---|
Investigation Responsibility | ||
Responsible Team * | ||
Target Completion Date * | DATE | |
Note/Comments | NVARCHAR(2000) | |
Investigation Questions | ||
All Questions | NVARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Dependencies | INT / INT | |
Questions Configuration based on Business Types & Operation Types (Near Miss & Injury / Illness) | INT / INT / INT | |
Ergonomic Analysis (Applicable only when respective question in Investigation Details is answered as Yes) | ||
All Questions | VARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Picklist Answer | NVARCHAR(500) | |
All Dependencies | INT / INT | |
Incident Specific Questions and its answers | INT / INT / INT | |
Contributing Factors | ||
Contributing Factors | INT / INT | |
5 Why ? Methodology | ||
Root Cause Evaluation | INT / INT | |
Contributing Factors | INT / NVARCHAR(50) | |
Whys | NVARCHAR(2000) | |
Check this box (If the above is FINAL ROOT CAUSE) | NVARCHAR(2000) | |
Root Cause Analysis | ||
Root Cause analysis | INT / INT | |
Comments | ||
Final Root Cause Statement | ||
Final Root cause statement | Nvarchar(4000) | |
Primary Countermeasure | INT / INT | |
Primary Root Cause | INT | |
Release / Impacts | ||
Environmental Media | INT | |
Impacts | Nvarchar(500) | |
Comments/Notes | Nvarchar(500) | |
Critique of response / Follow up | ||
All Questions | NVARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Dependencies | INT / INT |
Action Item Field List (Common to All Incident Types)
Section | Field Name | Database Column Size |
---|---|---|
Source Details | ||
Source ID | NVARCHAR(400) | |
Source Title | NVARCHAR(400) | |
Management Review Role | VARCHAR(50) | |
TMS Enabled Department | NVARCHAR(50) | |
TMS Work Order Number | NVARCHAR(100) | |
Create | ||
Action Item Title | NVARCHAR(50) | |
Action Item Category | ||
Action Item Type | NVARCHAR(50) | |
Root Cause | ||
Action Item Description | NVARCHAR(2000) | |
Action Item Priority | ||
Action Item Due Date | DATETIME | |
Owner | INT, NVARCHAR(50) | |
Responsible Department | INT | |
Countermeasure | INT | |
Applicable to Expansion? | NVARCHAR(10) | |
Description of Actions to be Expanded * | NVARCHAR(1000) | |
Applicable to EEM/EPM Info ? | NVARCHAR(10) | |
EEM / EPM * | NVARCHAR(10) | |
EEM/EPM Info Submitted ? | NVARCHAR(10) | |
Document Number * | NVARCHAR(200) | |
Assigned By | VARCHAR(50) | |
Verification required | INT | |
Verify User | ||
Approval | ||
Approval Status | INT | |
Approvers | ||
Approval Comment | NVARCHAR(2000) | |
Approval Date | DATETIME | |
Complete | ||
Action Item Status | ||
Action Taken | NVARCHAR(2000) | |
Action item Completed By | VARCHAR(50) | |
Action item Completed Date | DATETIME | |
Due Date Extension | NVARCHAR(50) | |
Requested Due Date Extension | NCHAR(10) | |
Reason for Due Date Extension | NVARCHAR(2000) | |
Due Date Extension Request Approved? | NVARCHAR(2000) | |
Reason for not extending the Due Date. | DATETIME | |
Review/Verify | ||
Verification Status | INT | |
Verification Performed | VARCHAR(50) | |
Verified By | INT | |
Verification Date | DATETIME | |
Comments | NVARCHAR(2000) | |
Cost Information | ||
Capital Expenditure involved | ||
Approximate cost | ||
Estimated Budget |
Environmental
Incident Details
Request
GET papi/v1/imsoutbound/environmentalincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}
Ex: papi/v1/imsoutbound/environmentalincidents?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. | 2222 |
Sample:
[ { "Incident ID (System Generated)": "sample string 3", "Incident Internal ID (System Generated)": "sample string 4", "Incident Title (No Personal data to be entered)": "sample string 5", "Incident Type": "sample string 6", "Location Code": "sample string 7", "Location Name": "sample string 8", "Incident Date": "2021-05-24T09:49:25.875Z", "Time of Incident": "sample string 9", "Time Undetermined": "sample string 10", "Day of Week": "sample string 11", "Work Shift": "sample string 12", "Time Work Day Began": "sample string 13", "Incident Severity": "sample string 14", "Incident Description": "sample string 15", "Incident Occurred on Employer's Premises": "sample string 16", "Address": "sample string 17", "City": "sample string 18", "County": "sample string 19", "Country": "sample string 20", "State": "sample string 21", "Postal/Zip Code": "sample string 22", "Department": "sample string 23", "Asset Involved Yes/No": "sample string 24", "Assets": "sample string 25", "Was a Corrective Action completed at time of reporting incident?": "sample string 26", "Date Reported To Employer": "2021-05-24T09:49:25.876Z", "Time Reported To Employer": "sample string 27", "Confirm Significance level of incident": "sample string 28", "Environmental Incident Type": "sample string 30", "Incident Cause Name": "sample string 31", "Occured ID": 32, "What Occurred": "sample string 33", "Weather": "sample string 34", "Hazard Classification": "sample string 35", "Severity": "sample string 36", "ERCA": "sample string 37", "Involved Shipping": "sample string 38", "Carrier Name": "sample string 39", "Contact Info": "sample string 40", "Vehicle ID#": "sample string 41", "Was the emergency Response Plan reviewed after the incident to see if changes are needed?": "sample string 42", "Release Environment": "sample string 43", "Was there a spill of substance?": "sample string 44", "Was there any hazardous material involved ?": "sample string 45", "If Yes, identify the Material": "sample string 46", "Do you have MSDS?": "sample string 47", "Was the facility evacuated?": "sample string 48", "Was a contractor involved in the incident?": "sample string 49", "Please provide Contractor Details (Name, Company, Phone, etc.)": "sample string 50", "Was the contractor trained on company policies?": "sample string 51", "Describe any damage caused.": "sample string 52", "Describe what caused the incident to occur.": "sample string 53", "Describe work activity being performed during incident": "sample string 54", "Was the applicable regulatory agency notified?": "sample string 55", "Employee Details": [ { "Was an Employee/IndividuaL involved in the incident ?": "sample string 2", "Personnel Type": "sample string 4", "Employee First Name": "sample string 5", "Employee Middle Name": "sample string 6", "Employee Last Name": "sample string 7", "Employee ID": "sample string 8", "Do you want to further classify Unsupervised Contract Employee": "sample string 9", "Type of Client Personnel": "sample string 10", "Client Company": "sample string 11", "Name of Contractor": "sample string 12", "Name of Sub-Contractor": "sample string 13", "Was any Machine / Equipment involved?": "sample string 14", "Machine/Equipment Number": "sample string 15", "Reviewed by EHS Representative": "sample string 16", "Review Date": "2021-05-24T09:49:25.878Z" }, { "Was an Employee/IndividuaL involved in the incident ?": "sample string 2", "Personnel Type": "sample string 4", "Employee First Name": "sample string 5", "Employee Middle Name": "sample string 6", "Employee Last Name": "sample string 7", "Employee ID": "sample string 8", "Do you want to further classify Unsupervised Contract Employee": "sample string 9", "Type of Client Personnel": "sample string 10", "Client Company": "sample string 11", "Name of Contractor": "sample string 12", "Name of Sub-Contractor": "sample string 13", "Was any Machine / Equipment involved?": "sample string 14", "Machine/Equipment Number": "sample string 15", "Reviewed by EHS Representative": "sample string 16", "Review Date": "2021-05-24T09:49:25.878Z" } ], "Substance Details": [ { "Name of Substance": "sample string 2", "Percentage of Mix": 3, "Amount Spilled": "sample string 4", "Amount Spilled Units": "sample string 5", "Amount Recovered Qty": "sample string 6", "Amount Recovered Units": "sample string 7", "Amount Disposed Qty": "sample string 8", "Amount Disposed Units": "sample string 9" }, { "Name of Substance": "sample string 2", "Percentage of Mix": 3, "Amount Spilled": "sample string 4", "Amount Spilled Units": "sample string 5", "Amount Recovered Qty": "sample string 6", "Amount Recovered Units": "sample string 7", "Amount Disposed Qty": "sample string 8", "Amount Disposed Units": "sample string 9" } ], "Agency Details": [ { "Agency Notified": "sample string 2", "Date of Notification": "2021-05-24T09:49:25.879Z", "Time of Notification": "sample string 3", "Contact Name": "sample string 4", "Contact Number": "sample string 5" }, { "Agency Notified": "sample string 2", "Date of Notification": "2021-05-24T09:49:25.879Z", "Time of Notification": "sample string 3", "Contact Name": "sample string 4", "Contact Number": "sample string 5" } ], "Are there any Witnesses identified?": "sample string 56", "Witness Details": [ { "Last Name": "sample string 2", "First Name": "sample string 3", "Middle Name": "sample string 4", "Phone Number": "sample string 5", "Notes": "sample string 6", "Relation Ship": "sample string 7" }, { "Last Name": "sample string 2", "First Name": "sample string 3", "Middle Name": "sample string 4", "Phone Number": "sample string 5", "Notes": "sample string 6", "Relation Ship": "sample string 7" } ], "Incident Status": "sample string 57", "Created By": "sample string 58", "Created Date": "2021-05-24T09:49:25.88Z", "Last Updated By": "sample string 59", "Last Updated Date": "sample string 60", "Investigation Responsibility Details": [ { "Target Completion Date": "2021-05-24T09:49:25.88Z", "Comments": "sample string 1", "Notify / YN": "sample string 2" }, { "Target Completion Date": "2021-05-24T09:49:25.88Z", "Comments": "sample string 1", "Notify / YN": "sample string 2" } ], "Investigation Responsibility assignee Details": [ { "UserID": 1, "Salutation": "sample string 2", "First Name": "sample string 3", "Last Name": "sample string 4" }, { "UserID": 1, "Salutation": "sample string 2", "First Name": "sample string 3", "Last Name": "sample string 4" } ], "Investigation questions Details": [ { "Question ID": 2, "Question": "sample string 3", "Answer": {}, "Answer ID": 5, "Parent Question ID": 6, "Parent Question": "sample string 7" }, { "Question ID": 2, "Question": "sample string 3", "Answer": {}, "Answer ID": 5, "Parent Question ID": 6, "Parent Question": "sample string 7" } ], "Contributing Factors Details": [ { "Parent Contributing Factor ID": 1, "Contributing Factor ID": 2, "Contributing Factor Name": "sample string 3", "Comments": "sample string 4" }, { "Parent Contributing Factor ID": 1, "Contributing Factor ID": 2, "Contributing Factor Name": "sample string 3", "Comments": "sample string 4" } ], "5Y Details": [ { "Evaluation ID": 1, "Contact Type": "sample string 2", "Others Description": "sample string 3", "Contact ID": "sample string 4" }, { "Evaluation ID": 1, "Contact Type": "sample string 2", "Others Description": "sample string 3", "Contact ID": "sample string 4" } ], "5Ys": [ { "Evaluation ID": 1, "Why Label": "sample string 2", "Why Check": "sample string 3" }, { "Evaluation ID": 1, "Why Label": "sample string 2", "Why Check": "sample string 3" } ], "Root Cause Details": [ { "Parent Root Cause Name": "sample string 2", "Root Cause Name": "sample string 3", "Comments": "sample string 4" }, { "Parent Root Cause Name": "sample string 2", "Root Cause Name": "sample string 3", "Comments": "sample string 4" } ], "Release Impact Details": [ { "Impacts": "sample string 3", "Comments": "sample string 4", "Environmental Media": "sample string 5" }, { "Impacts": "sample string 3", "Comments": "sample string 4", "Environmental Media": "sample string 5" } ], "Final root cause statement Details": [ { "IMSIncidentID": 1, "FinalRootCauseStatement": "sample string 2", "PrimaryCounterMeasure": "sample string 3", "PrimaryRootCause": "sample string 4" }, { "IMSIncidentID": 1, "FinalRootCauseStatement": "sample string 2", "PrimaryCounterMeasure": "sample string 3", "PrimaryRootCause": "sample string 4" } ], "Action Items Details": [ { "Source ID": "sample string 2", "Source Title": "sample string 3", "Action Item Title": "sample string 4", "Action Item Category": "sample string 5", "Action Item Type Id": 6, "Action Item Type": "sample string 7", "Root Cause": "sample string 8", "Action Item Description": "sample string 9", "Action Item Priority": "sample string 10", "Action Item Due Date": "2021-05-24T09:49:25.884Z", "Owner": "sample string 11", "Responsible Department": "sample string 12", "Counter Measure": "sample string 13", "Applicable to Expansion?": "sample string 14", "Description of Actions to be Expanded": "sample string 15", "Applicable to EEM/EPM Info?": "sample string 16", "EEM / EPM": "sample string 17", "EEM/EPM Info Submitted ?": "sample string 18", "Document Number ": "sample string 19", "Assigned By": "sample string 20", "Is Verification Required": 21, "Verification Required": "sample string 22", "VerifyUser": "sample string 23", "Approval Status": "sample string 24", "Approvers": "sample string 25", "Approval Comment": "sample string 26", "Approval Date": "2021-05-24T09:49:25.885Z", "Action Item Status": "sample string 27", "Action Taken": "sample string 28", "Action item Completed By": "sample string 29", "Action item Completed Date": "2021-05-24T09:49:25.885Z", "Due Date Extension": "sample string 30", "Requested Due Date Extension": "2021-05-24T09:49:25.885Z", "Reason for Due Date Extension": "sample string 31", "Due Date Extension Request Approved?": "sample string 32", "Reason for not extending the Due Date": "sample string 33", "Verification Status": "sample string 34", "Verification Performed": "sample string 35", "Verified By": "sample string 36", "Verification Date": "2021-05-24T09:49:25.885Z", "Comments": "sample string 37" }, { "Source ID": "sample string 2", "Source Title": "sample string 3", "Action Item Title": "sample string 4", "Action Item Category": "sample string 5", "Action Item Type Id": 6, "Action Item Type": "sample string 7", "Root Cause": "sample string 8", "Action Item Description": "sample string 9", "Action Item Priority": "sample string 10", "Action Item Due Date": "2021-05-24T09:49:25.884Z", "Owner": "sample string 11", "Responsible Department": "sample string 12", "Counter Measure": "sample string 13", "Applicable to Expansion?": "sample string 14", "Description of Actions to be Expanded": "sample string 15", "Applicable to EEM/EPM Info?": "sample string 16", "EEM / EPM": "sample string 17", "EEM/EPM Info Submitted ?": "sample string 18", "Document Number ": "sample string 19", "Assigned By": "sample string 20", "Is Verification Required": 21, "Verification Required": "sample string 22", "VerifyUser": "sample string 23", "Approval Status": "sample string 24", "Approvers": "sample string 25", "Approval Comment": "sample string 26", "Approval Date": "2021-05-24T09:49:25.885Z", "Action Item Status": "sample string 27", "Action Taken": "sample string 28", "Action item Completed By": "sample string 29", "Action item Completed Date": "2021-05-24T09:49:25.885Z", "Due Date Extension": "sample string 30", "Requested Due Date Extension": "2021-05-24T09:49:25.885Z", "Reason for Due Date Extension": "sample string 31", "Due Date Extension Request Approved?": "sample string 32", "Reason for not extending the Due Date": "sample string 33", "Verification Status": "sample string 34", "Verification Performed": "sample string 35", "Verified By": "sample string 36", "Verification Date": "2021-05-24T09:49:25.885Z", "Comments": "sample string 37" } ], "Management review Details": [ { "ROLE": "sample string 1", " PRIMARY_OWNER": "sample string 2", "DEFAULT_APPR_DUEDATE": "sample string 3", "COMMENTS": "sample string 4", "REVIEW_STATUS": "sample string 5", "COMPLETED_BY": "sample string 6", "COMPLETED_DATE": "sample string 7", "IMSIncidentID": 8 }, { "ROLE": "sample string 1", " PRIMARY_OWNER": "sample string 2", "DEFAULT_APPR_DUEDATE": "sample string 3", "COMMENTS": "sample string 4", "REVIEW_STATUS": "sample string 5", "COMPLETED_BY": "sample string 6", "COMPLETED_DATE": "sample string 7", "IMSIncidentID": 8 } ], "ManagementReviewStatus": "sample string 61" }, { "Incident ID (System Generated)": "sample string 3", "Incident Internal ID (System Generated)": "sample string 4", "Incident Title (No Personal data to be entered)": "sample string 5", "Incident Type": "sample string 6", "Location Code": "sample string 7", "Location Name": "sample string 8", "Incident Date": "2021-05-24T09:49:25.875Z", "Time of Incident": "sample string 9", "Time Undetermined": "sample string 10", "Day of Week": "sample string 11", "Work Shift": "sample string 12", "Time Work Day Began": "sample string 13", "Incident Severity": "sample string 14", "Incident Description": "sample string 15", "Incident Occurred on Employer's Premises": "sample string 16", "Address": "sample string 17", "City": "sample string 18", "County": "sample string 19", "Country": "sample string 20", "State": "sample string 21", "Postal/Zip Code": "sample string 22", "Department": "sample string 23", "Asset Involved Yes/No": "sample string 24", "Assets": "sample string 25", "Was a Corrective Action completed at time of reporting incident?": "sample string 26", "Date Reported To Employer": "2021-05-24T09:49:25.876Z", "Time Reported To Employer": "sample string 27", "Confirm Significance level of incident": "sample string 28", "Environmental Incident Type": "sample string 30", "Incident Cause Name": "sample string 31", "Occured ID": 32, "What Occurred": "sample string 33", "Weather": "sample string 34", "Hazard Classification": "sample string 35", "Severity": "sample string 36", "ERCA": "sample string 37", "Involved Shipping": "sample string 38", "Carrier Name": "sample string 39", "Contact Info": "sample string 40", "Vehicle ID#": "sample string 41", "Was the emergency Response Plan reviewed after the incident to see if changes are needed?": "sample string 42", "Release Environment": "sample string 43", "Was there a spill of substance?": "sample string 44", "Was there any hazardous material involved ?": "sample string 45", "If Yes, identify the Material": "sample string 46", "Do you have MSDS?": "sample string 47", "Was the facility evacuated?": "sample string 48", "Was a contractor involved in the incident?": "sample string 49", "Please provide Contractor Details (Name, Company, Phone, etc.)": "sample string 50", "Was the contractor trained on company policies?": "sample string 51", "Describe any damage caused.": "sample string 52", "Describe what caused the incident to occur.": "sample string 53", "Describe work activity being performed during incident": "sample string 54", "Was the applicable regulatory agency notified?": "sample string 55", "Employee Details": [ { "Was an Employee/IndividuaL involved in the incident ?": "sample string 2", "Personnel Type": "sample string 4", "Employee First Name": "sample string 5", "Employee Middle Name": "sample string 6", "Employee Last Name": "sample string 7", "Employee ID": "sample string 8", "Do you want to further classify Unsupervised Contract Employee": "sample string 9", "Type of Client Personnel": "sample string 10", "Client Company": "sample string 11", "Name of Contractor": "sample string 12", "Name of Sub-Contractor": "sample string 13", "Was any Machine / Equipment involved?": "sample string 14", "Machine/Equipment Number": "sample string 15", "Reviewed by EHS Representative": "sample string 16", "Review Date": "2021-05-24T09:49:25.878Z" }, { "Was an Employee/IndividuaL involved in the incident ?": "sample string 2", "Personnel Type": "sample string 4", "Employee First Name": "sample string 5", "Employee Middle Name": "sample string 6", "Employee Last Name": "sample string 7", "Employee ID": "sample string 8", "Do you want to further classify Unsupervised Contract Employee": "sample string 9", "Type of Client Personnel": "sample string 10", "Client Company": "sample string 11", "Name of Contractor": "sample string 12", "Name of Sub-Contractor": "sample string 13", "Was any Machine / Equipment involved?": "sample string 14", "Machine/Equipment Number": "sample string 15", "Reviewed by EHS Representative": "sample string 16", "Review Date": "2021-05-24T09:49:25.878Z" } ], "Substance Details": [ { "Name of Substance": "sample string 2", "Percentage of Mix": 3, "Amount Spilled": "sample string 4", "Amount Spilled Units": "sample string 5", "Amount Recovered Qty": "sample string 6", "Amount Recovered Units": "sample string 7", "Amount Disposed Qty": "sample string 8", "Amount Disposed Units": "sample string 9" }, { "Name of Substance": "sample string 2", "Percentage of Mix": 3, "Amount Spilled": "sample string 4", "Amount Spilled Units": "sample string 5", "Amount Recovered Qty": "sample string 6", "Amount Recovered Units": "sample string 7", "Amount Disposed Qty": "sample string 8", "Amount Disposed Units": "sample string 9" } ], "Agency Details": [ { "Agency Notified": "sample string 2", "Date of Notification": "2021-05-24T09:49:25.879Z", "Time of Notification": "sample string 3", "Contact Name": "sample string 4", "Contact Number": "sample string 5" }, { "Agency Notified": "sample string 2", "Date of Notification": "2021-05-24T09:49:25.879Z", "Time of Notification": "sample string 3", "Contact Name": "sample string 4", "Contact Number": "sample string 5" } ], "Are there any Witnesses identified?": "sample string 56", "Witness Details": [ { "Last Name": "sample string 2", "First Name": "sample string 3", "Middle Name": "sample string 4", "Phone Number": "sample string 5", "Notes": "sample string 6", "Relation Ship": "sample string 7" }, { "Last Name": "sample string 2", "First Name": "sample string 3", "Middle Name": "sample string 4", "Phone Number": "sample string 5", "Notes": "sample string 6", "Relation Ship": "sample string 7" } ], "Incident Status": "sample string 57", "Created By": "sample string 58", "Created Date": "2021-05-24T09:49:25.88Z", "Last Updated By": "sample string 59", "Last Updated Date": "sample string 60", "Investigation Responsibility Details": [ { "Target Completion Date": "2021-05-24T09:49:25.88Z", "Comments": "sample string 1", "Notify / YN": "sample string 2" }, { "Target Completion Date": "2021-05-24T09:49:25.88Z", "Comments": "sample string 1", "Notify / YN": "sample string 2" } ], "Investigation Responsibility assignee Details": [ { "UserID": 1, "Salutation": "sample string 2", "First Name": "sample string 3", "Last Name": "sample string 4" }, { "UserID": 1, "Salutation": "sample string 2", "First Name": "sample string 3", "Last Name": "sample string 4" } ], "Investigation questions Details": [ { "Question ID": 2, "Question": "sample string 3", "Answer": {}, "Answer ID": 5, "Parent Question ID": 6, "Parent Question": "sample string 7" }, { "Question ID": 2, "Question": "sample string 3", "Answer": {}, "Answer ID": 5, "Parent Question ID": 6, "Parent Question": "sample string 7" } ], "Contributing Factors Details": [ { "Parent Contributing Factor ID": 1, "Contributing Factor ID": 2, "Contributing Factor Name": "sample string 3", "Comments": "sample string 4" }, { "Parent Contributing Factor ID": 1, "Contributing Factor ID": 2, "Contributing Factor Name": "sample string 3", "Comments": "sample string 4" } ], "5Y Details": [ { "Evaluation ID": 1, "Contact Type": "sample string 2", "Others Description": "sample string 3", "Contact ID": "sample string 4" }, { "Evaluation ID": 1, "Contact Type": "sample string 2", "Others Description": "sample string 3", "Contact ID": "sample string 4" } ], "5Ys": [ { "Evaluation ID": 1, "Why Label": "sample string 2", "Why Check": "sample string 3" }, { "Evaluation ID": 1, "Why Label": "sample string 2", "Why Check": "sample string 3" } ], "Root Cause Details": [ { "Parent Root Cause Name": "sample string 2", "Root Cause Name": "sample string 3", "Comments": "sample string 4" }, { "Parent Root Cause Name": "sample string 2", "Root Cause Name": "sample string 3", "Comments": "sample string 4" } ], "Release Impact Details": [ { "Impacts": "sample string 3", "Comments": "sample string 4", "Environmental Media": "sample string 5" }, { "Impacts": "sample string 3", "Comments": "sample string 4", "Environmental Media": "sample string 5" } ], "Final root cause statement Details": [ { "IMSIncidentID": 1, "FinalRootCauseStatement": "sample string 2", "PrimaryCounterMeasure": "sample string 3", "PrimaryRootCause": "sample string 4" }, { "IMSIncidentID": 1, "FinalRootCauseStatement": "sample string 2", "PrimaryCounterMeasure": "sample string 3", "PrimaryRootCause": "sample string 4" } ], "Action Items Details": [ { "Source ID": "sample string 2", "Source Title": "sample string 3", "Action Item Title": "sample string 4", "Action Item Category": "sample string 5", "Action Item Type Id": 6, "Action Item Type": "sample string 7", "Root Cause": "sample string 8", "Action Item Description": "sample string 9", "Action Item Priority": "sample string 10", "Action Item Due Date": "2021-05-24T09:49:25.884Z", "Owner": "sample string 11", "Responsible Department": "sample string 12", "Counter Measure": "sample string 13", "Applicable to Expansion?": "sample string 14", "Description of Actions to be Expanded": "sample string 15", "Applicable to EEM/EPM Info?": "sample string 16", "EEM / EPM": "sample string 17", "EEM/EPM Info Submitted ?": "sample string 18", "Document Number ": "sample string 19", "Assigned By": "sample string 20", "Is Verification Required": 21, "Verification Required": "sample string 22", "VerifyUser": "sample string 23", "Approval Status": "sample string 24", "Approvers": "sample string 25", "Approval Comment": "sample string 26", "Approval Date": "2021-05-24T09:49:25.885Z", "Action Item Status": "sample string 27", "Action Taken": "sample string 28", "Action item Completed By": "sample string 29", "Action item Completed Date": "2021-05-24T09:49:25.885Z", "Due Date Extension": "sample string 30", "Requested Due Date Extension": "2021-05-24T09:49:25.885Z", "Reason for Due Date Extension": "sample string 31", "Due Date Extension Request Approved?": "sample string 32", "Reason for not extending the Due Date": "sample string 33", "Verification Status": "sample string 34", "Verification Performed": "sample string 35", "Verified By": "sample string 36", "Verification Date": "2021-05-24T09:49:25.885Z", "Comments": "sample string 37" }, { "Source ID": "sample string 2", "Source Title": "sample string 3", "Action Item Title": "sample string 4", "Action Item Category": "sample string 5", "Action Item Type Id": 6, "Action Item Type": "sample string 7", "Root Cause": "sample string 8", "Action Item Description": "sample string 9", "Action Item Priority": "sample string 10", "Action Item Due Date": "2021-05-24T09:49:25.884Z", "Owner": "sample string 11", "Responsible Department": "sample string 12", "Counter Measure": "sample string 13", "Applicable to Expansion?": "sample string 14", "Description of Actions to be Expanded": "sample string 15", "Applicable to EEM/EPM Info?": "sample string 16", "EEM / EPM": "sample string 17", "EEM/EPM Info Submitted ?": "sample string 18", "Document Number ": "sample string 19", "Assigned By": "sample string 20", "Is Verification Required": 21, "Verification Required": "sample string 22", "VerifyUser": "sample string 23", "Approval Status": "sample string 24", "Approvers": "sample string 25", "Approval Comment": "sample string 26", "Approval Date": "2021-05-24T09:49:25.885Z", "Action Item Status": "sample string 27", "Action Taken": "sample string 28", "Action item Completed By": "sample string 29", "Action item Completed Date": "2021-05-24T09:49:25.885Z", "Due Date Extension": "sample string 30", "Requested Due Date Extension": "2021-05-24T09:49:25.885Z", "Reason for Due Date Extension": "sample string 31", "Due Date Extension Request Approved?": "sample string 32", "Reason for not extending the Due Date": "sample string 33", "Verification Status": "sample string 34", "Verification Performed": "sample string 35", "Verified By": "sample string 36", "Verification Date": "2021-05-24T09:49:25.885Z", "Comments": "sample string 37" } ], "Management review Details": [ { "ROLE": "sample string 1", " PRIMARY_OWNER": "sample string 2", "DEFAULT_APPR_DUEDATE": "sample string 3", "COMMENTS": "sample string 4", "REVIEW_STATUS": "sample string 5", "COMPLETED_BY": "sample string 6", "COMPLETED_DATE": "sample string 7", "IMSIncidentID": 8 }, { "ROLE": "sample string 1", " PRIMARY_OWNER": "sample string 2", "DEFAULT_APPR_DUEDATE": "sample string 3", "COMMENTS": "sample string 4", "REVIEW_STATUS": "sample string 5", "COMPLETED_BY": "sample string 6", "COMPLETED_DATE": "sample string 7", "IMSIncidentID": 8 } ], "ManagementReviewStatus": "sample string 61" } ]
Injury/Illness and Claim Field List
Section | Field Name | Database Column Size |
---|---|---|
Incident Detail | ||
Incident ID * | NVARCHAR(400) | |
Internal Incident ID | NVARCHAR(200) | |
Incident Title/Site* | NVARCHAR(400) | |
Incident Type * | INT | |
Were multiple people injured as part of this incident? | NVARCHAR(50) | |
General Details | ||
Is this a MSHA Related Incident*? | NVARCHAR(100) | |
Date of Incident * | DATETIME | |
Time of Incident * | NVARCHAR(100) | |
Time undetermined | NVARCHAR(10) | |
Day Of Week ** | NVARCHAR(100) | |
Length of Normal Workday | NVARCHAR(100) | |
Work Shift ** | INT | |
Time Work Day Began ** | NVARCHAR(200) | |
Description of Incident * | NVARCHAR(8000) | |
Incident Occurred on Employer's Premises * | NVARCHAR(6) | |
Address of Incident Location * | NVARCHAR(1000) | |
City * | NVARCHAR(100) | |
County | NVARCHAR(100) | |
Country * | NVARCHAR(100) | |
State/Province * | NVARCHAR(100) | |
Postal Code/Zip Code | NVARCHAR(100) | |
Department * | INT | |
Department where the incident/injury occurred | INT | |
Location of Injury Scene | NVARCHAR(1000) | |
Date and Time Reported to Employer | DATETIME | |
Time | NVARCHAR(200) | |
Confirm Significance level of incident | INT | |
Employee / Individual Details | ||
Personnel Type * | INT | |
Employee / Individual Involved ( Last, First, M.I.) * | NVARCHAR(200), NVARCHAR(200), NVARCHAR(200) | |
Employee Id * | NVARCHAR(200) | |
Do you want to further classify Unsupervised Contract Employee | NVARCHAR(50) | |
Type of Client Personnel | NVARCHAR(20) | |
Client Company | NVARCHAR(100) | |
Name of Contractor | NVARCHAR(800) | |
Name of Sub-Contractor | NVARCHAR(800) | |
Was any Machine / Equipment involved? | NVARCHAR(100) | |
Machine/Equipment Number | NVARCHAR(400) | |
Reviewed by EHS Representative | NVARCHAR(800) | |
Review Date | DateTime | |
Substance Details | ||
Name of Substance | NVARCHAR(1000) | |
Percentage of Mix | INT | |
Amount Spilled | NVARCHAR(100) | |
Amount Spilled Units | INT | |
Amount Recovered Qty | NVARCHAR(1000) | |
Amount Recovered Units | INT | |
Amount Disposed Qty | NVARCHAR(1000) | |
Amount Disposed Units | INT | |
Agency Details | ||
Agency Notified | NVARCHAR(100) | |
Date of Notification | DATETIME | |
Time of Notification | NVARCHAR(50) | |
Contact Name | NVARCHAR(100) | |
Contact Number | NVARCHAR(100) | |
Environmental Incident Details | ||
Environmental Incident Type | NVARCHAR(50) | |
Cause of Incident | NVARCHAR (50) | |
Hazard Classification | NVARCHAR (400) | |
Severity | NVARCHAR(50) | |
ERCA Required? | NVARCHAR(50) | |
Weather conditions | NVARCHAR(500) | |
Note quantity/units spilled/leaked/emitted | NVARCHAR(100) | |
Did incident involve shipping of hazardous material | NVARCHAR(50) | |
Carrier Name | NVARCHAR(50) | |
Contact Info | NVARCHAR(50) | |
Vehicle ID# | NVARCHAR(50) | |
Was the emergency Response Plan reviewed after the incident to see if changes are needed? | NVARCHAR(50) | |
Was there a release to the environment? | NVARCHAR(50) | |
Was there a spill of substance? | NVARCHAR(50) | |
Damage Summary | ||
Was there any hazardous material involved ? | NVARCHAR(50) | |
If Yes, identify the Material | NNVARCHAR(50) | |
Do you have MSDS? | NVARCHAR(500) | |
Was the facility evacuated? | NVARCHAR(500) | |
Was a Contractor Involved in the Incident? | NVARCHAR(50) | |
Please Provide Contractor Details (Name, Company, Phone, etc.) | NVARCHAR(50) | |
Was The Contractor Trained On Company Policies? | NVARCHAR(50) | |
Describe Any Damage Caused | NVARCHAR(50) | |
Describe What Caused the Incident To Occur | NVARCHAR(50) | |
Describe Work Activity Being Performed During Incident | NVARCHAR(50) | |
Was the Applicable Regulatory Agency Notified? | NVARCHAR(50) | |
Witness Information | ||
Are there any Witnesses identified? | NVARCHAR(20) | |
Number of Witnesses | INT | |
Last Name | NVARCHAR(50) | |
First Name | NVARCHAR(50) | |
Middle Name | NVARCHAR(50) | |
Phone Number | NVARCHAR(100) | |
Notes | NVARCHAR(2000) | |
Witness relation to <CUSTOMER> Coworker, friend, public, supervisor, venue employee | NVARCHAR(500) | |
Additional Incident Information | ||
Incident Status | NVARCHAR(100) | |
Created By | NVARCHAR(100) | |
Created Date | DATETIME | |
Last Updated By | NVARCHAR(100) | |
Last Updated Date | DATETIME |
Investigation Sections Field List (Common to All Incident Types)
Section | Field Name | Database Column Size |
---|---|---|
Investigation Responsibility | ||
Responsible Team * | ||
Target Completion Date * | DATE | |
Note/Comments | NVARCHAR(2000) | |
Investigation Questions | ||
All Questions | NVARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Dependencies | INT / INT | |
Questions Configuration based on Business Types & Operation Types (Near Miss & Injury / Illness) | INT / INT / INT | |
Ergonomic Analysis (Applicable only when respective question in Investigation Details is answered as Yes) | ||
All Questions | VARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Picklist Answer | NVARCHAR(500) | |
All Dependencies | INT / INT | |
Incident Specific Questions and its answers | INT / INT / INT | |
Contributing Factors | ||
Contributing Factors | INT / INT | |
5 Why ? Methodology | ||
Root Cause Evaluation | INT / INT | |
Contributing Factors | INT / NVARCHAR(50) | |
Whys | NVARCHAR(2000) | |
Check this box (If the above is FINAL ROOT CAUSE) | NVARCHAR(2000) | |
Root Cause Analysis | ||
Root Cause analysis | INT / INT | |
Comments | ||
Final Root Cause Statement | ||
Final Root cause statement | Nvarchar(4000) | |
Primary Countermeasure | INT / INT | |
Primary Root Cause | INT | |
Release / Impacts | ||
Environmental Media | INT | |
Impacts | Nvarchar(500) | |
Comments/Notes | Nvarchar(500) | |
Critique of response / Follow up | ||
All Questions | NVARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Dependencies | INT / INT |
Action Item Field List (Common to All Incident Types)
Section | Field Name | Database Column Size |
---|---|---|
Source Details | ||
Source ID | NVARCHAR(400) | |
Source Title | NVARCHAR(400) | |
Management Review Role | VARCHAR(50) | |
TMS Enabled Department | NVARCHAR(50) | |
TMS Work Order Number | NVARCHAR(100) | |
Create | ||
Action Item Title | NVARCHAR(50) | |
Action Item Category | ||
Action Item Type | NVARCHAR(50) | |
Root Cause | ||
Action Item Description | NVARCHAR(2000) | |
Action Item Priority | ||
Action Item Due Date | DATETIME | |
Owner | INT, NVARCHAR(50) | |
Responsible Department | INT | |
Countermeasure | INT | |
Applicable to Expansion? | NVARCHAR(10) | |
Description of Actions to be Expanded * | NVARCHAR(1000) | |
Applicable to EEM/EPM Info ? | NVARCHAR(10) | |
EEM / EPM * | NVARCHAR(10) | |
EEM/EPM Info Submitted ? | NVARCHAR(10) | |
Document Number * | NVARCHAR(200) | |
Assigned By | VARCHAR(50) | |
Verification required | INT | |
Verify User | ||
Approval | ||
Approval Status | INT | |
Approvers | ||
Approval Comment | NVARCHAR(2000) | |
Approval Date | DATETIME | |
Complete | ||
Action Item Status | ||
Action Taken | NVARCHAR(2000) | |
Action item Completed By | VARCHAR(50) | |
Action item Completed Date | DATETIME | |
Due Date Extension | NVARCHAR(50) | |
Requested Due Date Extension | NCHAR(10) | |
Reason for Due Date Extension | NVARCHAR(2000) | |
Due Date Extension Request Approved? | NVARCHAR(2000) | |
Reason for not extending the Due Date. | DATETIME | |
Review/Verify | ||
Verification Status | INT | |
Verification Performed | VARCHAR(50) | |
Verified By | INT | |
Verification Date | DATETIME | |
Comments | NVARCHAR(2000) | |
Cost Information | ||
Capital Expenditure involved | ||
Approximate cost | ||
Estimated Budget |
Errors/Validation Messages
Generic Error codes are given below.
HTTP ERROR 401
{
"HttpStatusCode": 401,
"HttpStatus": "Unauthorized",
"ErrorCode": 1030,
"ErrorMessage": "Invalid tenant."
}
If the location code given is invalid:
{
"Message": "Invalid Location Code"
}
(When FromDate, ToDate and LastSyncedDate are empty) or (FromDate, ToDate and LastSyncedDate are given in incorrect format of DD-MM-YYYY)
{
"Message": "Date From or Date To should not be empty"
}
When FromDate is greater than ToDate and LastSyncedDate is empty
{
"Message": "Date From is greater than Date To"
}
When LastSyncedDate is greater than current date
{
"Message": "Last Synced Date is a Future Date"
}
Questions
Below is a list of questions to be addressed as a result of this requirements document:
Question | Outcome |
---|---|
We would like to start playing with Location (papi/v1/location) and IMS (papi/v1/ims) services and I have a few questions. | Data would be exposed per Location |
I assume we have to use the App (papi/v1/auth/app) Endpoint to obtain the authentication token for our Integration application to submit further requests. How can we obtain ConsumerId, App Id and ConsumerKey? How long the token is valid? How will we find out that the token has expired (HTTP 401,403)? | Any Existing Valid User credentials along with the ConsumerKey can be used to call the Auth API.PMAP would provide the Unique ConsumerKey to the Customer. If the User is valid, an Authorization Token is generated which can be used further in the Header to call Module Endpoints.If it is successful, data can be extracted else HTTP 401 Error is thrown. Each Authorization Token is valid for lifetime unless there is any change in the ConsumerKey. User can request PMAP to reset the Token anytime. |
How can we obtain UserId required for papi/v1/locations/all/{UserId} and other services? Does UserId identify Bunge as a user among other customers? | Yes.. Any Existing Valid User credentials for any specific customer can be used to call the Auth API. |
papi/v1/ims/incidents service specifies that LocationId is required and accepts only a single value. Does it mean that we have to submit a request for each location? Can you describe the effect of the lastSynced parameter? | Yes.For now the data can be viewed for one Location only per request. |