v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Accidents

Executes the Add action for the Accidents data object.

Adds a new Accident record.

post/direct/subscribers/{subscriber_code}/vista/hr/2/data/accidents/actions/add

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

HRCointeger required

HR Company Code.

Accidentstring required

Accident/Incident ID.

AccidentDatestring required

Date of Accident/Incident. Format: YYYY-MM-DD.

AccidentTimestring nullable

Time of Accident/Incident.

EmployerPremYN'Y' | 'N'

Was the accident/incident on employer premises? Options: Y-Yes, N-No.

JobSiteYN'Y' | 'N'

Was the accident/incident at a job site? Options: Y-Yes, N-No.

Locationstring nullable

Location of Accident/Incident.

JCCointeger nullable

Job Cost Company Code.

Jobstring nullable

Job/Project Number.

ReportedBystring nullable

Reported By Name.

PhaseGroupinteger nullable

Phase Group.

Phasestring nullable

Phase Code.

DateReportedstring nullable

Date Reported. Format: YYYY-MM-DD.

TimeReportedstring nullable

Time Reported.

ClosedDatestring nullable

Date Accident/Incident was closed. Format: YYYY-MM-DD.

MSHAIDstring nullable

MSHA ID.

MineNamestring nullable

Mine Name.

CorrectiveActionstring nullable

Corrective Action taken.

Notesstring nullable

Accident/Incident notes.

UniqueAttchIDstring nullable

Unique Attachment ID (GUID).

__custom_fieldsobject

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Response

Success

idstring

operationstring

statusstring