Trendsic Platform Service

<back to all web services

SafetyIncidentListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/safety/incidents
SafetyIncidentListRequest Parameters:
NameParameterData TypeRequiredDescription
FromDatequeryDateTime?No
ToDatequeryDateTime?No
ProjectIDqueryint?No
SafetyIncidentListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IncidentsformList<SafetyIncident>No
SafetyIncident Parameters:
NameParameterData TypeRequiredDescription
SafetyIncidentIDformintNo
SafetyIncidentUIDformGuidNo
BranchIdformGuid?No
ProjectIDformint?No
IncidentNoformstringNo
IncidentTypeformstringNo
SeverityformstringNo
StatusformstringNo
TitleformstringNo
LocationformstringNo
CrewLabelformstringNo
DescriptionformstringNo
ReportedByformstringNo
IsRecordableformboolNo
OccurredAtformDateTime?No
ClosedAtformDateTime?No
SourceRefformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
DaysAgoformintNo

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
		}
	]
}