SafetyService
First available in SystemsLink 2017.3.0
Use SafetyService to record and retrieve accidents and other information related to moving and nonmoving safety violations and incidents, including vehicle crash damage, bodily injury, cargo and property damage, costs, insurance information, etc. Information in the Safety Report is available in driver, tractor, and trailer profiles in the File Maintenance application if the TMWSuite Safety Report Systems add-on is licensed.
Endpoint Address: [SystemsLinkRootUrl]/SafetyService.svc
Methods
Method Name | Parameters | C# return type | Description | |
---|---|---|---|---|
Name |
C# data type |
|||
Delete() |
safetyId |
int |
void |
Delete an item by Safety Id. |
Get() |
List<Safety> |
Get a list of safety items by asset type and Id. |
||
assetId |
string |
|||
GetSafetyReport() |
id |
int |
Safety |
Get a Safety Report by Id. |
NewItem() |
Safety |
Create a safety item. |
||
Save() |
safety |
Safety |
Safety |
Save a safety item. |
Search() |
filter |
FilterObjectsOfSafety |
PagedResultOfSafety |
Return a paged result of safety items based on the filter. |
Safety object properties and column mapping
Columns in Database column Name are from the SAFETYREPORT database table. |
Property | Database column | Comments | ||
---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
CargoDamageCost |
decimal? |
srp_cargodamagecost |
money |
Monetary amount of damage done to cargo. |
Carrier |
string |
srp_carrier |
varchar(8) |
Carrier associated with the safety incident. |
ClaimDate |
DateTime? |
srp_date1 |
datetime |
Date claim made. |
ClaimNumber |
string |
srp_claimnbr |
varchar(25) |
Unique identifier for a claim. |
Classification |
string |
srp_Classification |
varchar(6) |
Classification of safety record. |
CommodityCode |
string |
cmd_code |
varchar(8) |
Unique identifier for a specific commodity. |
ControlData |
string |
Do not set. Read only. Not mapped to database. |
||
CreatedBy |
string |
Read only. Not mapped to database. |
||
CreatedDateTime |
DateTime? |
Read only. Not mapped to database. |
||
Description |
string |
srp_description |
varchar(255) |
Description of safety incident. |
Driver1 |
string |
srp_driver1 |
varchar(8) |
First driver associated with safety incident. |
Driver2 |
string |
srp_driver2 |
varchar(8) |
Second driver associated with safety incident. |
EstimatedCost |
decimal? |
srp_EstCost |
money |
Estimated costs of damages. |
EventDate |
DateTime? |
srp_EventDate |
datetime |
Date the safety event occurred. |
EventLocation |
Location |
See Safety EventLocation. |
||
Hazardous |
int? |
srp_Hazmat |
tinyint |
Boolean to flag if hazardous. |
InsuranceCompanyLocation |
Location |
|||
InsuranceCompanyName |
string |
srp_inscompany |
varchar(100) |
Name of insurance company associated with the safety incident. |
InsurancePolicyNumber |
string |
srp_inspolicynbr |
varchar(50) |
Unique identifier for the insurance company policy number. |
IsReportedToInsurance |
bool? |
srp_reportedtoinsurance |
char(1) |
Boolean to flag if the incident has been reported. If not null, "Y" or "N". |
LegNumber |
int? |
lgh_number |
int |
Unique identifier for a trip leg associated with the safety incident. |
MoveNumber |
int? |
mov_number |
int |
Unique identifier for a move associated with the safety incident. |
OnPremises |
bool? |
srp_OnPremises |
char(1) |
Boolean to flag if the incident occurred on site. If not null, "Y" or "N". |
OrderNumber |
string |
ord_number |
varchar(12) |
Unique identifier for an order associated with a safety incident. |
PropertyDamageCost |
decimal? |
srp_propdamagecost |
Money(19, 4) |
The monetary amount of property damage. |
ReportedBy |
string |
srp_ReportedBy |
varchar(8) |
Person that reported the safety incident. |
ReportedDate |
DateTime? |
srp_ReportedDate |
datetime |
Date the accident report filed. |
ReportId |
int |
srp_ID |
int |
Unique identifier to pull a report. |
ReportNumber |
string |
srp_number |
varchar(20) |
Unique identifier to pull a report. |
Requirement1Complete |
bool? |
srp_Req1Complete |
char(1) |
Record is requirement met or not. If not null, "Y" or "N". |
Requirement1CompleteDate |
DateTime? |
srp_Req1DtDone |
datetime |
Completion date of requirement. |
Requirement2Complete |
bool? |
srp_Req2Complete |
char(1) |
Record is requirement met or not. If not null, "Y" or "N". |
Requirement2CompleteDate |
DateTime? |
srp_Req2DtDone |
datetime |
Completion date of requirement. |
Requirement3Complete |
bool? |
srp_Req3Complete |
char(1) |
Record is requirement met or not. If not null, "Y" or "N". |
Requirement3CompleteDate |
DateTime? |
srp_Req3DtDone |
datetime |
Completion date of requirement. |
Requirement4Complete |
bool? |
srp_Req4Complete |
char(1) |
Record is requirement met or not. If not null, "Y" or "N". |
Requirement4CompleteDate |
DateTime? |
srp_Req4DtDone |
datetime |
Completion date of requirement. |
Requirement5Complete |
bool? |
srp_Req5Complete |
char(1) |
Record is requirement met or not. If not null, "Y" or "N". |
Requirement5CompleteDate |
DateTime? |
srp_Req5DtDone |
datetime |
Completion date of requirement. |
Requirement6Complete |
bool? |
srp_Req6Complete |
char(1) |
Record is requirement met or not. If not null, "Y" or "N". |
Requirement6CompleteDate |
DateTime? |
srp_Req6DtDone |
datetime |
Completion date of requirement. |
ResponsibleParty |
string |
srp_ResponsibleParty |
varchar(6) |
Party responsible for safety incident. |
RuleData |
Read only. Not mapped to database. |
|||
SafetyType1 |
string |
srp_SafetyType1 |
varchar(6) |
Labelfile user determined field. |
SafetyType2 |
string |
srp_SafetyType2 |
varchar(6) |
Labelfile user determined field. |
SafetyType3 |
string |
srp_SafetyType3 |
varchar(6) |
Labelfile user determined field. |
SafetyType4 |
string |
srp_SafetyType4 |
varchar(6) |
Labelfile user determined field. |
SafetyType5 |
string |
srp_SafetyType5 |
varchar(6) |
Labelfile user determined field. |
SafetyType6 |
string |
srp_SafetyType6 |
varchar(6) |
Labelfile user determined field. |
SafetyType7 |
string |
srp_SafetyType7 |
varchar(6) |
Labelfile user determined field. |
SafetyType8 |
string |
srp_SafetyType8 |
varchar(6) |
Labelfile user determined field. |
Status |
string |
srp_SafetyStatus |
varchar(6) |
Get status of an asset. |
TotalCompanyPaid |
decimal? |
srp_TotalPaidByCmp |
money |
Total amount paid by company. |
TotalInsurancePaid |
decimal? |
srp_TotalPaidByIns |
money |
Total amount paid by insurance company. |
TotalRecovered |
decimal? |
srp_TotalRecovered |
money |
Total amount recovered from an incident. |
TotalReserves |
decimal? |
srp_TotalReserves |
money |
Total amount needed to satisfy the financial requirements of a claim. |
Tractor |
string |
srp_tractor |
varchar(8) |
Tractor involved in safety incident. |
Trailer1 |
string |
srp_trailer1 |
varchar(13) |
First trailer involved in safety incident. |
Trailer2 |
string |
srp_trailer2 |
varchar(13) |
Second trailer involved in safety incident. |
UpdateDateTime |
DateTime? |
Read only. Not mapped to database. |
||
UpdatedBy |
string |
Read only. Not mapped to database. |
||
VehicleDamageCost |
decimal? |
srp_vdamagecost |
money |
Total monetary amount of vehicle damage. |
Safety EventLocation object properties and column mappings
Location where the safety incident occurred.
Columns in Database column Name are from the SAFETYREPORT database table. |
Property | Database column | Comments | ||
---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
Id |
string |
srp_EventLocCmpID |
varchar(8) |
First address associated with the safety incident. |
AdhocLocation |
AdhocAddress |
Not mapped to database. |
Safety EventLocation AdhocLocation object properties and column mappings
Columns in Database column Name are from the SAFETYREPORT database table. |
Property | Database column | Comments | ||
---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
Address1 |
string |
srp_EventAddress1 |
varchar(100) |
First address associated with the safety incident. |
Address2 |
string |
srp_EventAddress2 |
varchar(100) |
Second address associated with the safety incident. |
CityId |
int? |
Not used. |
||
Name |
string |
srp_Eventctynmstct |
varchar(25) |
Name of city where safety incident occurred. |
ZipCode |
string |
srp_EventZip |
varchar(10) |
ZIP code where safety incident occurred. |
Insurance company location
Insurance company safety incident location information.
Columns in Database column Name are from the SAFETYREPORT database table. |
Property | Database column | Comments | ||
---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
Address1 |
string |
srp_inscoaddress |
varchar(100) |
First address associated with the safety incident. |
Address2 |
string |
srp_inscostate |
varchar(6) |
First address associated with the safety incident. |
CityID |
int? |
inscocity |
int |
ID of city where safety incident occurred. |
Name |
string |
Not used. |
||
ZipCode |
string |
srp_inscozip |
varchar(10) |
ZIP code where safety incident occurred. |