| POST,OPTIONS | /v1/Equipment/{EquipmentID}/dvir/signoff |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EquipmentID | path | int | No | |
| Defects | body | List<DvirSignOffItem> | No | |
| MechanicName | body | string | No | |
| SignaturePng | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DvirDefectID | form | int | No | |
| Outcome | form | string | No | |
| Note | form | string | No | |
| ScheduledFor | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Vehicle | form | DvirVehicleDetail | No | |
| Returned | form | bool | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Plate | form | string | No | |
| VIN | form | string | No | |
| GvwrLbs | form | int? | No | |
| BranchName | form | string | No | |
| InspectionDue | form | DateTime? | No | |
| InsuranceExpires | form | DateTime? | No | |
| RecentlyFixed | form | List<DvirDefectView> | No | |
| ReviewReports | form | List<DvirReportView> | No | |
| History | form | List<DvirReportView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EquipmentID | form | int | No | |
| Unit | form | string | No | |
| Name | form | string | No | |
| VehicleType | form | string | No | |
| IsTrailer | form | bool | No | |
| VehicleStatus | form | string | No | |
| Status | form | string | No | |
| StatusText | form | string | No | |
| Line | form | string | No | |
| FirstUnsafeReport | form | string | No | |
| OpenCount | form | int | No | |
| LocalToday | form | string | No | |
| NeedsPreTrip | form | bool | No | |
| NeedsReview | form | bool | No | |
| ReviewReportIds | form | List<int> | No | |
| Trailers | form | List<DvirUnitRef> | No | |
| LastOdometer | form | int? | No | |
| InUseBy | form | string | No | |
| DrivingNow | form | bool | No | |
| TodayPreTripId | form | int? | No | |
| TodayPostTripId | form | int? | No | |
| OpenDefects | form | List<DvirDefectView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EquipmentID | form | int | No | |
| Unit | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DvirDefectID | form | int | No | |
| ClientKey | form | string | No | |
| DvirReportID | form | int? | No | |
| ReportNumber | form | string | No | |
| EquipmentID | form | int | No | |
| Unit | form | string | No | |
| ItemKey | form | string | No | |
| Label | form | string | No | |
| FormLine | form | string | No | |
| IsCustom | form | bool | No | |
| Severity | form | string | No | |
| SeverityText | form | string | No | |
| Note | form | string | No | |
| Source | form | string | No | |
| ReportedByName | form | string | No | |
| ReportedAtUtc | form | DateTime? | No | |
| EquipmentMaintenanceID | form | int? | No | |
| Outcome | form | string | No | |
| OutcomeText | form | string | No | |
| OutcomeNote | form | string | No | |
| ScheduledFor | form | string | No | |
| SignedOffByName | form | string | No | |
| SignedOffAtUtc | form | DateTime? | No | |
| IsOpen | form | bool | No | |
| Withdrawn | form | bool | No | |
| PhotoCount | form | int | No | |
| Photos | form | List<DvirPhotoView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WorkPhotoID | form | int | No | |
| DefectKey | form | string | No | |
| Url | form | string | No | |
| MarkedUrl | form | string | No | |
| CapturedAtUtc | form | DateTime? | No | |
| Lat | form | decimal? | No | |
| Lng | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DvirReportID | form | int | No | |
| Number | form | string | No | |
| Kind | form | string | No | |
| KindText | form | string | No | |
| EquipmentID | form | int | No | |
| Unit | form | string | No | |
| Trailers | form | List<DvirUnitRef> | No | |
| ContactID | form | int | No | |
| DriverName | form | string | No | |
| Board | form | string | No | |
| ForDate | form | string | No | |
| FiledAtUtc | form | DateTime | No | |
| SavedAtUtc | form | DateTime? | No | |
| IsLate | form | bool | No | |
| IsAway | form | bool | No | |
| IsSatisfactory | form | bool | No | |
| Odometer | form | int? | No | |
| LocationText | form | string | No | |
| Remarks | form | string | No | |
| ReviewedByName | form | string | No | |
| ReviewedAtUtc | form | DateTime? | No | |
| Chip | form | string | No | |
| Defects | form | List<DvirDefectView> | No | |
| Signatures | form | List<DvirSignatureView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SignatureRecordID | form | int | No | |
| Role | form | string | No | |
| SignerName | form | string | No | |
| SignedAt | form | DateTime? | No | |
| ImageUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}