Trendsic Platform Service

<back to all web services

SafetyIncidentListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/safety/incidents
"use strict";
export class SafetyIncident {
    /** @param {{SafetyIncidentID?:number,SafetyIncidentUID?:string,BranchId?:string,ProjectID?:number,IncidentNo?:string,IncidentType?:string,Severity?:string,Status?:string,Title?:string,Location?:string,CrewLabel?:string,Description?:string,ReportedBy?:string,IsRecordable?:boolean,OccurredAt?:string,ClosedAt?:string,SourceRef?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,DaysAgo?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SafetyIncidentID;
    /** @type {string} */
    SafetyIncidentUID;
    /** @type {?string} */
    BranchId;
    /** @type {?number} */
    ProjectID;
    /** @type {string} */
    IncidentNo;
    /** @type {string} */
    IncidentType;
    /** @type {string} */
    Severity;
    /** @type {string} */
    Status;
    /** @type {string} */
    Title;
    /** @type {string} */
    Location;
    /** @type {string} */
    CrewLabel;
    /** @type {string} */
    Description;
    /** @type {string} */
    ReportedBy;
    /** @type {boolean} */
    IsRecordable;
    /** @type {?string} */
    OccurredAt;
    /** @type {?string} */
    ClosedAt;
    /** @type {string} */
    SourceRef;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {number} */
    DaysAgo;
}
export class SafetyIncidentListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Incidents?:SafetyIncident[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SafetyIncident[]} */
    Incidents = [];
}
export class SafetyIncidentListRequest {
    /** @param {{FromDate?:string,ToDate?:string,ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    FromDate;
    /** @type {?string} */
    ToDate;
    /** @type {?number} */
    ProjectID;
}

JavaScript SafetyIncidentListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/safety/incidents HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Incidents: 
	[
		{
			SafetyIncidentID: 0,
			SafetyIncidentUID: 00000000000000000000000000000000,
			BranchId: 00000000000000000000000000000000,
			ProjectID: 0,
			IncidentNo: String,
			IncidentType: String,
			Severity: String,
			Status: String,
			Title: String,
			Location: String,
			CrewLabel: String,
			Description: String,
			ReportedBy: String,
			IsRecordable: False,
			OccurredAt: 0001-01-01,
			ClosedAt: 0001-01-01,
			SourceRef: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			DaysAgo: 0
		}
	]
}