incidents/{id}

Retrieves an incident by ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

An incident ID

integer

Required

Body Parameters

None.

Response Information

Standard Responses

An incident

InspectionResponseDto

NameDescriptionTypeAdditional information
sections

A list of sections

Collection of InspectionSectionDto

None.

id

The ID of the inspection, meeting or incident/hazard.

integer

None.

uuid

The template Id of the inspection, meeting, or incident/hazard

globally unique identifier

None.

title

The title of the inspection, meeting or incident/hazard.

string

None.

subTitle

The substitle of the inspection, meeting or incident/hazard.

string

None.

status

The current status of the inspection, meeting or incident/hazard.

string

None.

signedOffDate

The date that the inspection, meeting or incident/hazard was signed off.

string

None.

createdDate

The date that the inspection, meeting or incident/hazard was created in eCMS.

string

None.

site

The site that the inspection, meeting or incident/hazard was created at/belongs to.

string

None.

owner

The user who owns the inspection, meeting or incident/hazard.

string

None.

hasScoring

Indicates if scoring is enabled or disabled

boolean

None.

totalScorePercentage

Indicates the total score as a percentage, provided scoring is enabled

decimal number

None.

inspectionPassed

Indicates Pass/Fail based on the score

boolean

None.

header

Header of the inpection. All fields are string. Static fields are "Prepared by", "Location", "OrganizationName", "GpsLocation","Date" All other fields are defined dynamically by the Custom Header of the inpection

Collection of Object

None.

links

Collection of LinkDto

None.

Error Responses

None.
HTTP Status CodeError MessageTypeAdditional Information