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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class EquipmentDvirSignOffRequest
{
    open var EquipmentID:Int? = null
    open var Defects:ArrayList<DvirSignOffItem> = ArrayList<DvirSignOffItem>()
    open var MechanicName:String? = null
    open var SignaturePng:String? = null
}

open class DvirSignOffItem
{
    open var DvirDefectID:Int? = null
    open var Outcome:String? = null
    open var Note:String? = null
    open var ScheduledFor:String? = null
}

open class EquipmentDvirSignOffResponse
{
    open var Vehicle:DvirVehicleDetail? = null
    open var Returned:Boolean? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DvirVehicleDetail : DvirVehicleView()
{
    open var Plate:String? = null
    open var VIN:String? = null
    open var GvwrLbs:Int? = null
    open var BranchName:String? = null
    open var InspectionDue:Date? = null
    open var InsuranceExpires:Date? = null
    open var RecentlyFixed:ArrayList<DvirDefectView> = ArrayList<DvirDefectView>()
    open var ReviewReports:ArrayList<DvirReportView> = ArrayList<DvirReportView>()
    open var History:ArrayList<DvirReportView> = ArrayList<DvirReportView>()
}

open class DvirVehicleView
{
    open var EquipmentID:Int? = null
    open var Unit:String? = null
    open var Name:String? = null
    open var VehicleType:String? = null
    open var IsTrailer:Boolean? = null
    open var VehicleStatus:String? = null
    open var Status:String? = null
    open var StatusText:String? = null
    open var Line:String? = null
    open var FirstUnsafeReport:String? = null
    open var OpenCount:Int? = null
    open var LocalToday:String? = null
    open var NeedsPreTrip:Boolean? = null
    open var NeedsReview:Boolean? = null
    open var ReviewReportIds:ArrayList<Int> = ArrayList<Int>()
    open var Trailers:ArrayList<DvirUnitRef> = ArrayList<DvirUnitRef>()
    open var LastOdometer:Int? = null
    open var InUseBy:String? = null
    open var DrivingNow:Boolean? = null
    open var TodayPreTripId:Int? = null
    open var TodayPostTripId:Int? = null
    open var OpenDefects:ArrayList<DvirDefectView> = ArrayList<DvirDefectView>()
}

open class DvirUnitRef
{
    open var EquipmentID:Int? = null
    open var Unit:String? = null
}

open class DvirDefectView
{
    open var DvirDefectID:Int? = null
    open var ClientKey:String? = null
    open var DvirReportID:Int? = null
    open var ReportNumber:String? = null
    open var EquipmentID:Int? = null
    open var Unit:String? = null
    open var ItemKey:String? = null
    open var Label:String? = null
    open var FormLine:String? = null
    open var IsCustom:Boolean? = null
    open var Severity:String? = null
    open var SeverityText:String? = null
    open var Note:String? = null
    open var Source:String? = null
    open var ReportedByName:String? = null
    open var ReportedAtUtc:Date? = null
    open var EquipmentMaintenanceID:Int? = null
    open var Outcome:String? = null
    open var OutcomeText:String? = null
    open var OutcomeNote:String? = null
    open var ScheduledFor:String? = null
    open var SignedOffByName:String? = null
    open var SignedOffAtUtc:Date? = null
    open var IsOpen:Boolean? = null
    open var Withdrawn:Boolean? = null
    open var PhotoCount:Int? = null
    open var Photos:ArrayList<DvirPhotoView> = ArrayList<DvirPhotoView>()
}

open class DvirPhotoView
{
    open var WorkPhotoID:Int? = null
    open var DefectKey:String? = null
    open var Url:String? = null
    open var MarkedUrl:String? = null
    open var CapturedAtUtc:Date? = null
    open var Lat:BigDecimal? = null
    open var Lng:BigDecimal? = null
}

open class DvirReportView
{
    open var DvirReportID:Int? = null
    open var Number:String? = null
    open var Kind:String? = null
    open var KindText:String? = null
    open var EquipmentID:Int? = null
    open var Unit:String? = null
    open var Trailers:ArrayList<DvirUnitRef> = ArrayList<DvirUnitRef>()
    open var ContactID:Int? = null
    open var DriverName:String? = null
    open var Board:String? = null
    open var ForDate:String? = null
    open var FiledAtUtc:Date? = null
    open var SavedAtUtc:Date? = null
    open var IsLate:Boolean? = null
    open var IsAway:Boolean? = null
    open var IsSatisfactory:Boolean? = null
    open var Odometer:Int? = null
    open var LocationText:String? = null
    open var Remarks:String? = null
    open var ReviewedByName:String? = null
    open var ReviewedAtUtc:Date? = null
    open var Chip:String? = null
    open var Defects:ArrayList<DvirDefectView> = ArrayList<DvirDefectView>()
    open var Signatures:ArrayList<DvirSignatureView> = ArrayList<DvirSignatureView>()
}

open class DvirSignatureView
{
    open var SignatureRecordID:Int? = null
    open var Role:String? = null
    open var SignerName:String? = null
    open var SignedAt:Date? = null
    open var ImageUrl:String? = null
}

Kotlin EquipmentDvirSignOffRequest 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.

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