Trendsic Platform Service

<back to all web services

EquipmentDvirSignOffRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/Equipment/{EquipmentID}/dvir/signoff
EquipmentDvirSignOffRequest Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDpathintNo
DefectsbodyList<DvirSignOffItem>No
MechanicNamebodystringNo
SignaturePngbodystringNo
DvirSignOffItem Parameters:
NameParameterData TypeRequiredDescription
DvirDefectIDformintNo
OutcomeformstringNo
NoteformstringNo
ScheduledForformstringNo
EquipmentDvirSignOffResponse Parameters:
NameParameterData TypeRequiredDescription
VehicleformDvirVehicleDetailNo
ReturnedformboolNo
ResponseStatusformResponseStatusNo
DvirVehicleDetail Parameters:
NameParameterData TypeRequiredDescription
PlateformstringNo
VINformstringNo
GvwrLbsformint?No
BranchNameformstringNo
InspectionDueformDateTime?No
InsuranceExpiresformDateTime?No
RecentlyFixedformList<DvirDefectView>No
ReviewReportsformList<DvirReportView>No
HistoryformList<DvirReportView>No
DvirVehicleView Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
UnitformstringNo
NameformstringNo
VehicleTypeformstringNo
IsTrailerformboolNo
VehicleStatusformstringNo
StatusformstringNo
StatusTextformstringNo
LineformstringNo
FirstUnsafeReportformstringNo
OpenCountformintNo
LocalTodayformstringNo
NeedsPreTripformboolNo
NeedsReviewformboolNo
ReviewReportIdsformList<int>No
TrailersformList<DvirUnitRef>No
LastOdometerformint?No
InUseByformstringNo
DrivingNowformboolNo
TodayPreTripIdformint?No
TodayPostTripIdformint?No
OpenDefectsformList<DvirDefectView>No
DvirUnitRef Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
UnitformstringNo
DvirDefectView Parameters:
NameParameterData TypeRequiredDescription
DvirDefectIDformintNo
ClientKeyformstringNo
DvirReportIDformint?No
ReportNumberformstringNo
EquipmentIDformintNo
UnitformstringNo
ItemKeyformstringNo
LabelformstringNo
FormLineformstringNo
IsCustomformboolNo
SeverityformstringNo
SeverityTextformstringNo
NoteformstringNo
SourceformstringNo
ReportedByNameformstringNo
ReportedAtUtcformDateTime?No
EquipmentMaintenanceIDformint?No
OutcomeformstringNo
OutcomeTextformstringNo
OutcomeNoteformstringNo
ScheduledForformstringNo
SignedOffByNameformstringNo
SignedOffAtUtcformDateTime?No
IsOpenformboolNo
WithdrawnformboolNo
PhotoCountformintNo
PhotosformList<DvirPhotoView>No
DvirPhotoView Parameters:
NameParameterData TypeRequiredDescription
WorkPhotoIDformintNo
DefectKeyformstringNo
UrlformstringNo
MarkedUrlformstringNo
CapturedAtUtcformDateTime?No
Latformdecimal?No
Lngformdecimal?No
DvirReportView Parameters:
NameParameterData TypeRequiredDescription
DvirReportIDformintNo
NumberformstringNo
KindformstringNo
KindTextformstringNo
EquipmentIDformintNo
UnitformstringNo
TrailersformList<DvirUnitRef>No
ContactIDformintNo
DriverNameformstringNo
BoardformstringNo
ForDateformstringNo
FiledAtUtcformDateTimeNo
SavedAtUtcformDateTime?No
IsLateformboolNo
IsAwayformboolNo
IsSatisfactoryformboolNo
Odometerformint?No
LocationTextformstringNo
RemarksformstringNo
ReviewedByNameformstringNo
ReviewedAtUtcformDateTime?No
ChipformstringNo
DefectsformList<DvirDefectView>No
SignaturesformList<DvirSignatureView>No
DvirSignatureView Parameters:
NameParameterData TypeRequiredDescription
SignatureRecordIDformintNo
RoleformstringNo
SignerNameformstringNo
SignedAtformDateTime?No
ImageUrlformstringNo

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.

POST /v1/Equipment/{EquipmentID}/dvir/signoff HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EquipmentID: 0,
	Defects: 
	[
		{
			DvirDefectID: 0,
			Outcome: String,
			Note: String,
			ScheduledFor: String
		}
	],
	MechanicName: String,
	SignaturePng: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Vehicle: 
	{
		Plate: String,
		VIN: String,
		GvwrLbs: 0,
		BranchName: String,
		InspectionDue: 0001-01-01,
		InsuranceExpires: 0001-01-01,
		RecentlyFixed: 
		[
			{
				DvirDefectID: 0,
				ClientKey: String,
				DvirReportID: 0,
				ReportNumber: String,
				EquipmentID: 0,
				Unit: String,
				ItemKey: String,
				Label: String,
				FormLine: String,
				IsCustom: False,
				Severity: String,
				SeverityText: String,
				Note: String,
				Source: String,
				ReportedByName: String,
				ReportedAtUtc: 0001-01-01,
				EquipmentMaintenanceID: 0,
				Outcome: String,
				OutcomeText: String,
				OutcomeNote: String,
				ScheduledFor: String,
				SignedOffByName: String,
				SignedOffAtUtc: 0001-01-01,
				IsOpen: False,
				Withdrawn: False,
				PhotoCount: 0,
				Photos: 
				[
					{
						WorkPhotoID: 0,
						DefectKey: String,
						Url: String,
						MarkedUrl: String,
						CapturedAtUtc: 0001-01-01,
						Lat: 0,
						Lng: 0
					}
				]
			}
		],
		ReviewReports: 
		[
			{
				DvirReportID: 0,
				Number: String,
				Kind: String,
				KindText: String,
				EquipmentID: 0,
				Unit: String,
				Trailers: 
				[
					{
						EquipmentID: 0,
						Unit: String
					}
				],
				ContactID: 0,
				DriverName: String,
				Board: String,
				ForDate: String,
				FiledAtUtc: 0001-01-01,
				SavedAtUtc: 0001-01-01,
				IsLate: False,
				IsAway: False,
				IsSatisfactory: False,
				Odometer: 0,
				LocationText: String,
				Remarks: String,
				ReviewedByName: String,
				ReviewedAtUtc: 0001-01-01,
				Chip: String,
				Defects: 
				[
					{
						DvirDefectID: 0,
						ClientKey: String,
						DvirReportID: 0,
						ReportNumber: String,
						EquipmentID: 0,
						Unit: String,
						ItemKey: String,
						Label: String,
						FormLine: String,
						IsCustom: False,
						Severity: String,
						SeverityText: String,
						Note: String,
						Source: String,
						ReportedByName: String,
						ReportedAtUtc: 0001-01-01,
						EquipmentMaintenanceID: 0,
						Outcome: String,
						OutcomeText: String,
						OutcomeNote: String,
						ScheduledFor: String,
						SignedOffByName: String,
						SignedOffAtUtc: 0001-01-01,
						IsOpen: False,
						Withdrawn: False,
						PhotoCount: 0,
						Photos: 
						[
							{
								WorkPhotoID: 0,
								DefectKey: String,
								Url: String,
								MarkedUrl: String,
								CapturedAtUtc: 0001-01-01,
								Lat: 0,
								Lng: 0
							}
						]
					}
				],
				Signatures: 
				[
					{
						SignatureRecordID: 0,
						Role: String,
						SignerName: String,
						SignedAt: 0001-01-01,
						ImageUrl: String
					}
				]
			}
		],
		History: 
		[
			{
				DvirReportID: 0,
				Number: String,
				Kind: String,
				KindText: String,
				EquipmentID: 0,
				Unit: String,
				Trailers: 
				[
					{
						EquipmentID: 0,
						Unit: String
					}
				],
				ContactID: 0,
				DriverName: String,
				Board: String,
				ForDate: String,
				FiledAtUtc: 0001-01-01,
				SavedAtUtc: 0001-01-01,
				IsLate: False,
				IsAway: False,
				IsSatisfactory: False,
				Odometer: 0,
				LocationText: String,
				Remarks: String,
				ReviewedByName: String,
				ReviewedAtUtc: 0001-01-01,
				Chip: String,
				Defects: 
				[
					{
						DvirDefectID: 0,
						ClientKey: String,
						DvirReportID: 0,
						ReportNumber: String,
						EquipmentID: 0,
						Unit: String,
						ItemKey: String,
						Label: String,
						FormLine: String,
						IsCustom: False,
						Severity: String,
						SeverityText: String,
						Note: String,
						Source: String,
						ReportedByName: String,
						ReportedAtUtc: 0001-01-01,
						EquipmentMaintenanceID: 0,
						Outcome: String,
						OutcomeText: String,
						OutcomeNote: String,
						ScheduledFor: String,
						SignedOffByName: String,
						SignedOffAtUtc: 0001-01-01,
						IsOpen: False,
						Withdrawn: False,
						PhotoCount: 0,
						Photos: 
						[
							{
								WorkPhotoID: 0,
								DefectKey: String,
								Url: String,
								MarkedUrl: String,
								CapturedAtUtc: 0001-01-01,
								Lat: 0,
								Lng: 0
							}
						]
					}
				],
				Signatures: 
				[
					{
						SignatureRecordID: 0,
						Role: String,
						SignerName: String,
						SignedAt: 0001-01-01,
						ImageUrl: String
					}
				]
			}
		],
		EquipmentID: 0,
		Unit: String,
		Name: String,
		VehicleType: String,
		IsTrailer: False,
		VehicleStatus: String,
		Status: String,
		StatusText: String,
		Line: String,
		FirstUnsafeReport: String,
		OpenCount: 0,
		LocalToday: String,
		NeedsPreTrip: False,
		NeedsReview: False,
		ReviewReportIds: 
		[
			0
		],
		Trailers: 
		[
			{
				EquipmentID: 0,
				Unit: String
			}
		],
		LastOdometer: 0,
		InUseBy: String,
		DrivingNow: False,
		TodayPreTripId: 0,
		TodayPostTripId: 0,
		OpenDefects: 
		[
			{
				DvirDefectID: 0,
				ClientKey: String,
				DvirReportID: 0,
				ReportNumber: String,
				EquipmentID: 0,
				Unit: String,
				ItemKey: String,
				Label: String,
				FormLine: String,
				IsCustom: False,
				Severity: String,
				SeverityText: String,
				Note: String,
				Source: String,
				ReportedByName: String,
				ReportedAtUtc: 0001-01-01,
				EquipmentMaintenanceID: 0,
				Outcome: String,
				OutcomeText: String,
				OutcomeNote: String,
				ScheduledFor: String,
				SignedOffByName: String,
				SignedOffAtUtc: 0001-01-01,
				IsOpen: False,
				Withdrawn: False,
				PhotoCount: 0,
				Photos: 
				[
					{
						WorkPhotoID: 0,
						DefectKey: String,
						Url: String,
						MarkedUrl: String,
						CapturedAtUtc: 0001-01-01,
						Lat: 0,
						Lng: 0
					}
				]
			}
		]
	},
	Returned: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}