| POST,OPTIONS | /v1/Equipment/{EquipmentID}/dvir/signoff |
|---|
export class DvirUnitRef
{
public EquipmentID: number;
public Unit: string;
public constructor(init?: Partial<DvirUnitRef>) { (Object as any).assign(this, init); }
}
export class DvirPhotoView
{
public WorkPhotoID: number;
public DefectKey: string;
public Url: string;
public MarkedUrl: string;
public CapturedAtUtc?: string;
public Lat?: number;
public Lng?: number;
public constructor(init?: Partial<DvirPhotoView>) { (Object as any).assign(this, init); }
}
export class DvirDefectView
{
public DvirDefectID: number;
public ClientKey: string;
public DvirReportID?: number;
public ReportNumber: string;
public EquipmentID: number;
public Unit: string;
public ItemKey: string;
public Label: string;
public FormLine: string;
public IsCustom: boolean;
public Severity: string;
public SeverityText: string;
public Note: string;
public Source: string;
public ReportedByName: string;
public ReportedAtUtc?: string;
public EquipmentMaintenanceID?: number;
public Outcome: string;
public OutcomeText: string;
public OutcomeNote: string;
public ScheduledFor: string;
public SignedOffByName: string;
public SignedOffAtUtc?: string;
public IsOpen: boolean;
public Withdrawn: boolean;
public PhotoCount: number;
public Photos: DvirPhotoView[] = [];
public constructor(init?: Partial<DvirDefectView>) { (Object as any).assign(this, init); }
}
export class DvirVehicleView
{
public EquipmentID: number;
public Unit: string;
public Name: string;
public VehicleType: string;
public IsTrailer: boolean;
public VehicleStatus: string;
public Status: string;
public StatusText: string;
public Line: string;
public FirstUnsafeReport: string;
public OpenCount: number;
public LocalToday: string;
public NeedsPreTrip: boolean;
public NeedsReview: boolean;
public ReviewReportIds: number[] = [];
public Trailers: DvirUnitRef[] = [];
public LastOdometer?: number;
public InUseBy: string;
public DrivingNow: boolean;
public TodayPreTripId?: number;
public TodayPostTripId?: number;
public OpenDefects: DvirDefectView[] = [];
public constructor(init?: Partial<DvirVehicleView>) { (Object as any).assign(this, init); }
}
export class DvirSignatureView
{
public SignatureRecordID: number;
public Role: string;
public SignerName: string;
public SignedAt?: string;
public ImageUrl: string;
public constructor(init?: Partial<DvirSignatureView>) { (Object as any).assign(this, init); }
}
export class DvirReportView
{
public DvirReportID: number;
public Number: string;
public Kind: string;
public KindText: string;
public EquipmentID: number;
public Unit: string;
public Trailers: DvirUnitRef[] = [];
public ContactID: number;
public DriverName: string;
public Board: string;
public ForDate: string;
public FiledAtUtc: string;
public SavedAtUtc?: string;
public IsLate: boolean;
public IsAway: boolean;
public IsSatisfactory: boolean;
public Odometer?: number;
public LocationText: string;
public Remarks: string;
public ReviewedByName: string;
public ReviewedAtUtc?: string;
public Chip: string;
public Defects: DvirDefectView[] = [];
public Signatures: DvirSignatureView[] = [];
public constructor(init?: Partial<DvirReportView>) { (Object as any).assign(this, init); }
}
export class DvirVehicleDetail extends DvirVehicleView
{
public Plate: string;
public VIN: string;
public GvwrLbs?: number;
public BranchName: string;
public InspectionDue?: string;
public InsuranceExpires?: string;
public RecentlyFixed: DvirDefectView[] = [];
public ReviewReports: DvirReportView[] = [];
public History: DvirReportView[] = [];
public constructor(init?: Partial<DvirVehicleDetail>) { super(init); (Object as any).assign(this, init); }
}
export class EquipmentDvirSignOffResponse
{
public Vehicle: DvirVehicleDetail;
public Returned: boolean;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<EquipmentDvirSignOffResponse>) { (Object as any).assign(this, init); }
}
export class DvirSignOffItem
{
public DvirDefectID: number;
public Outcome: string;
public Note: string;
public ScheduledFor: string;
public constructor(init?: Partial<DvirSignOffItem>) { (Object as any).assign(this, init); }
}
export class EquipmentDvirSignOffRequest
{
public EquipmentID: number;
public Defects: DvirSignOffItem[] = [];
public MechanicName: string;
public SignaturePng: string;
public constructor(init?: Partial<EquipmentDvirSignOffRequest>) { (Object as any).assign(this, init); }
}
TypeScript EquipmentDvirSignOffRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length
{"Vehicle":{"Plate":"String","VIN":"String","GvwrLbs":0,"BranchName":"String","InspectionDue":"0001-01-01T00:00:00.0000000","InsuranceExpires":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","EquipmentMaintenanceID":0,"Outcome":"String","OutcomeText":"String","OutcomeNote":"String","ScheduledFor":"String","SignedOffByName":"String","SignedOffAtUtc":"0001-01-01T00:00:00.0000000","IsOpen":false,"Withdrawn":false,"PhotoCount":0,"Photos":[{"WorkPhotoID":0,"DefectKey":"String","Url":"String","MarkedUrl":"String","CapturedAtUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","SavedAtUtc":"0001-01-01T00:00:00.0000000","IsLate":false,"IsAway":false,"IsSatisfactory":false,"Odometer":0,"LocationText":"String","Remarks":"String","ReviewedByName":"String","ReviewedAtUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","EquipmentMaintenanceID":0,"Outcome":"String","OutcomeText":"String","OutcomeNote":"String","ScheduledFor":"String","SignedOffByName":"String","SignedOffAtUtc":"0001-01-01T00:00:00.0000000","IsOpen":false,"Withdrawn":false,"PhotoCount":0,"Photos":[{"WorkPhotoID":0,"DefectKey":"String","Url":"String","MarkedUrl":"String","CapturedAtUtc":"0001-01-01T00:00:00.0000000","Lat":0,"Lng":0}]}],"Signatures":[{"SignatureRecordID":0,"Role":"String","SignerName":"String","SignedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","SavedAtUtc":"0001-01-01T00:00:00.0000000","IsLate":false,"IsAway":false,"IsSatisfactory":false,"Odometer":0,"LocationText":"String","Remarks":"String","ReviewedByName":"String","ReviewedAtUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","EquipmentMaintenanceID":0,"Outcome":"String","OutcomeText":"String","OutcomeNote":"String","ScheduledFor":"String","SignedOffByName":"String","SignedOffAtUtc":"0001-01-01T00:00:00.0000000","IsOpen":false,"Withdrawn":false,"PhotoCount":0,"Photos":[{"WorkPhotoID":0,"DefectKey":"String","Url":"String","MarkedUrl":"String","CapturedAtUtc":"0001-01-01T00:00:00.0000000","Lat":0,"Lng":0}]}],"Signatures":[{"SignatureRecordID":0,"Role":"String","SignerName":"String","SignedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","EquipmentMaintenanceID":0,"Outcome":"String","OutcomeText":"String","OutcomeNote":"String","ScheduledFor":"String","SignedOffByName":"String","SignedOffAtUtc":"0001-01-01T00:00:00.0000000","IsOpen":false,"Withdrawn":false,"PhotoCount":0,"Photos":[{"WorkPhotoID":0,"DefectKey":"String","Url":"String","MarkedUrl":"String","CapturedAtUtc":"0001-01-01T00:00:00.0000000","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"}}}