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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DvirUnitRef() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Unit:String = null with get,set

    [<AllowNullLiteral>]
    type DvirPhotoView() = 
        member val WorkPhotoID:Int32 = new Int32() with get,set
        member val DefectKey:String = null with get,set
        member val Url:String = null with get,set
        member val MarkedUrl:String = null with get,set
        member val CapturedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Lat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Lng:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type DvirDefectView() = 
        member val DvirDefectID:Int32 = new Int32() with get,set
        member val ClientKey:String = null with get,set
        member val DvirReportID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReportNumber:String = null with get,set
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Unit:String = null with get,set
        member val ItemKey:String = null with get,set
        member val Label:String = null with get,set
        member val FormLine:String = null with get,set
        member val IsCustom:Boolean = new Boolean() with get,set
        member val Severity:String = null with get,set
        member val SeverityText:String = null with get,set
        member val Note:String = null with get,set
        member val Source:String = null with get,set
        member val ReportedByName:String = null with get,set
        member val ReportedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EquipmentMaintenanceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Outcome:String = null with get,set
        member val OutcomeText:String = null with get,set
        member val OutcomeNote:String = null with get,set
        member val ScheduledFor:String = null with get,set
        member val SignedOffByName:String = null with get,set
        member val SignedOffAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsOpen:Boolean = new Boolean() with get,set
        member val Withdrawn:Boolean = new Boolean() with get,set
        member val PhotoCount:Int32 = new Int32() with get,set
        member val Photos:ResizeArray<DvirPhotoView> = new ResizeArray<DvirPhotoView>() with get,set

    [<AllowNullLiteral>]
    type DvirVehicleView() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Unit:String = null with get,set
        member val Name:String = null with get,set
        member val VehicleType:String = null with get,set
        member val IsTrailer:Boolean = new Boolean() with get,set
        member val VehicleStatus:String = null with get,set
        member val Status:String = null with get,set
        member val StatusText:String = null with get,set
        member val Line:String = null with get,set
        member val FirstUnsafeReport:String = null with get,set
        member val OpenCount:Int32 = new Int32() with get,set
        member val LocalToday:String = null with get,set
        member val NeedsPreTrip:Boolean = new Boolean() with get,set
        member val NeedsReview:Boolean = new Boolean() with get,set
        member val ReviewReportIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val Trailers:ResizeArray<DvirUnitRef> = new ResizeArray<DvirUnitRef>() with get,set
        member val LastOdometer:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InUseBy:String = null with get,set
        member val DrivingNow:Boolean = new Boolean() with get,set
        member val TodayPreTripId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TodayPostTripId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OpenDefects:ResizeArray<DvirDefectView> = new ResizeArray<DvirDefectView>() with get,set

    [<AllowNullLiteral>]
    type DvirSignatureView() = 
        member val SignatureRecordID:Int32 = new Int32() with get,set
        member val Role:String = null with get,set
        member val SignerName:String = null with get,set
        member val SignedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ImageUrl:String = null with get,set

    [<AllowNullLiteral>]
    type DvirReportView() = 
        member val DvirReportID:Int32 = new Int32() with get,set
        member val Number:String = null with get,set
        member val Kind:String = null with get,set
        member val KindText:String = null with get,set
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Unit:String = null with get,set
        member val Trailers:ResizeArray<DvirUnitRef> = new ResizeArray<DvirUnitRef>() with get,set
        member val ContactID:Int32 = new Int32() with get,set
        member val DriverName:String = null with get,set
        member val Board:String = null with get,set
        member val ForDate:String = null with get,set
        member val FiledAtUtc:DateTime = new DateTime() with get,set
        member val SavedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsLate:Boolean = new Boolean() with get,set
        member val IsAway:Boolean = new Boolean() with get,set
        member val IsSatisfactory:Boolean = new Boolean() with get,set
        member val Odometer:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LocationText:String = null with get,set
        member val Remarks:String = null with get,set
        member val ReviewedByName:String = null with get,set
        member val ReviewedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Chip:String = null with get,set
        member val Defects:ResizeArray<DvirDefectView> = new ResizeArray<DvirDefectView>() with get,set
        member val Signatures:ResizeArray<DvirSignatureView> = new ResizeArray<DvirSignatureView>() with get,set

    [<AllowNullLiteral>]
    type DvirVehicleDetail() = 
        inherit DvirVehicleView()
        member val Plate:String = null with get,set
        member val VIN:String = null with get,set
        member val GvwrLbs:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val BranchName:String = null with get,set
        member val InspectionDue:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val InsuranceExpires:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RecentlyFixed:ResizeArray<DvirDefectView> = new ResizeArray<DvirDefectView>() with get,set
        member val ReviewReports:ResizeArray<DvirReportView> = new ResizeArray<DvirReportView>() with get,set
        member val History:ResizeArray<DvirReportView> = new ResizeArray<DvirReportView>() with get,set

    [<AllowNullLiteral>]
    type EquipmentDvirSignOffResponse() = 
        member val Vehicle:DvirVehicleDetail = null with get,set
        member val Returned:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DvirSignOffItem() = 
        member val DvirDefectID:Int32 = new Int32() with get,set
        member val Outcome:String = null with get,set
        member val Note:String = null with get,set
        member val ScheduledFor:String = null with get,set

    [<AllowNullLiteral>]
    type EquipmentDvirSignOffRequest() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Defects:ResizeArray<DvirSignOffItem> = new ResizeArray<DvirSignOffItem>() with get,set
        member val MechanicName:String = null with get,set
        member val SignaturePng:String = null with get,set

F# EquipmentDvirSignOffRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<EquipmentDvirSignOffRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Defects>
    <DvirSignOffItem>
      <DvirDefectID>0</DvirDefectID>
      <Note>String</Note>
      <Outcome>String</Outcome>
      <ScheduledFor>String</ScheduledFor>
    </DvirSignOffItem>
  </Defects>
  <EquipmentID>0</EquipmentID>
  <MechanicName>String</MechanicName>
  <SignaturePng>String</SignaturePng>
</EquipmentDvirSignOffRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EquipmentDvirSignOffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Returned>false</Returned>
  <Vehicle>
    <DrivingNow>false</DrivingNow>
    <EquipmentID>0</EquipmentID>
    <FirstUnsafeReport>String</FirstUnsafeReport>
    <InUseBy>String</InUseBy>
    <IsTrailer>false</IsTrailer>
    <LastOdometer>0</LastOdometer>
    <Line>String</Line>
    <LocalToday>String</LocalToday>
    <Name>String</Name>
    <NeedsPreTrip>false</NeedsPreTrip>
    <NeedsReview>false</NeedsReview>
    <OpenCount>0</OpenCount>
    <OpenDefects>
      <DvirDefectView>
        <ClientKey>String</ClientKey>
        <DvirDefectID>0</DvirDefectID>
        <DvirReportID>0</DvirReportID>
        <EquipmentID>0</EquipmentID>
        <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
        <FormLine>String</FormLine>
        <IsCustom>false</IsCustom>
        <IsOpen>false</IsOpen>
        <ItemKey>String</ItemKey>
        <Label>String</Label>
        <Note>String</Note>
        <Outcome>String</Outcome>
        <OutcomeNote>String</OutcomeNote>
        <OutcomeText>String</OutcomeText>
        <PhotoCount>0</PhotoCount>
        <Photos>
          <DvirPhotoView>
            <CapturedAtUtc>0001-01-01T00:00:00</CapturedAtUtc>
            <DefectKey>String</DefectKey>
            <Lat>0</Lat>
            <Lng>0</Lng>
            <MarkedUrl>String</MarkedUrl>
            <Url>String</Url>
            <WorkPhotoID>0</WorkPhotoID>
          </DvirPhotoView>
        </Photos>
        <ReportNumber>String</ReportNumber>
        <ReportedAtUtc>0001-01-01T00:00:00</ReportedAtUtc>
        <ReportedByName>String</ReportedByName>
        <ScheduledFor>String</ScheduledFor>
        <Severity>String</Severity>
        <SeverityText>String</SeverityText>
        <SignedOffAtUtc>0001-01-01T00:00:00</SignedOffAtUtc>
        <SignedOffByName>String</SignedOffByName>
        <Source>String</Source>
        <Unit>String</Unit>
        <Withdrawn>false</Withdrawn>
      </DvirDefectView>
    </OpenDefects>
    <ReviewReportIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </ReviewReportIds>
    <Status>String</Status>
    <StatusText>String</StatusText>
    <TodayPostTripId>0</TodayPostTripId>
    <TodayPreTripId>0</TodayPreTripId>
    <Trailers>
      <DvirUnitRef>
        <EquipmentID>0</EquipmentID>
        <Unit>String</Unit>
      </DvirUnitRef>
    </Trailers>
    <Unit>String</Unit>
    <VehicleStatus>String</VehicleStatus>
    <VehicleType>String</VehicleType>
    <BranchName>String</BranchName>
    <GvwrLbs>0</GvwrLbs>
    <History>
      <DvirReportView>
        <Board>String</Board>
        <Chip>String</Chip>
        <ContactID>0</ContactID>
        <Defects>
          <DvirDefectView>
            <ClientKey>String</ClientKey>
            <DvirDefectID>0</DvirDefectID>
            <DvirReportID>0</DvirReportID>
            <EquipmentID>0</EquipmentID>
            <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
            <FormLine>String</FormLine>
            <IsCustom>false</IsCustom>
            <IsOpen>false</IsOpen>
            <ItemKey>String</ItemKey>
            <Label>String</Label>
            <Note>String</Note>
            <Outcome>String</Outcome>
            <OutcomeNote>String</OutcomeNote>
            <OutcomeText>String</OutcomeText>
            <PhotoCount>0</PhotoCount>
            <Photos>
              <DvirPhotoView>
                <CapturedAtUtc>0001-01-01T00:00:00</CapturedAtUtc>
                <DefectKey>String</DefectKey>
                <Lat>0</Lat>
                <Lng>0</Lng>
                <MarkedUrl>String</MarkedUrl>
                <Url>String</Url>
                <WorkPhotoID>0</WorkPhotoID>
              </DvirPhotoView>
            </Photos>
            <ReportNumber>String</ReportNumber>
            <ReportedAtUtc>0001-01-01T00:00:00</ReportedAtUtc>
            <ReportedByName>String</ReportedByName>
            <ScheduledFor>String</ScheduledFor>
            <Severity>String</Severity>
            <SeverityText>String</SeverityText>
            <SignedOffAtUtc>0001-01-01T00:00:00</SignedOffAtUtc>
            <SignedOffByName>String</SignedOffByName>
            <Source>String</Source>
            <Unit>String</Unit>
            <Withdrawn>false</Withdrawn>
          </DvirDefectView>
        </Defects>
        <DriverName>String</DriverName>
        <DvirReportID>0</DvirReportID>
        <EquipmentID>0</EquipmentID>
        <FiledAtUtc>0001-01-01T00:00:00</FiledAtUtc>
        <ForDate>String</ForDate>
        <IsAway>false</IsAway>
        <IsLate>false</IsLate>
        <IsSatisfactory>false</IsSatisfactory>
        <Kind>String</Kind>
        <KindText>String</KindText>
        <LocationText>String</LocationText>
        <Number>String</Number>
        <Odometer>0</Odometer>
        <Remarks>String</Remarks>
        <ReviewedAtUtc>0001-01-01T00:00:00</ReviewedAtUtc>
        <ReviewedByName>String</ReviewedByName>
        <SavedAtUtc>0001-01-01T00:00:00</SavedAtUtc>
        <Signatures>
          <DvirSignatureView>
            <ImageUrl>String</ImageUrl>
            <Role>String</Role>
            <SignatureRecordID>0</SignatureRecordID>
            <SignedAt>0001-01-01T00:00:00</SignedAt>
            <SignerName>String</SignerName>
          </DvirSignatureView>
        </Signatures>
        <Trailers>
          <DvirUnitRef>
            <EquipmentID>0</EquipmentID>
            <Unit>String</Unit>
          </DvirUnitRef>
        </Trailers>
        <Unit>String</Unit>
      </DvirReportView>
    </History>
    <InspectionDue>0001-01-01T00:00:00</InspectionDue>
    <InsuranceExpires>0001-01-01T00:00:00</InsuranceExpires>
    <Plate>String</Plate>
    <RecentlyFixed>
      <DvirDefectView>
        <ClientKey>String</ClientKey>
        <DvirDefectID>0</DvirDefectID>
        <DvirReportID>0</DvirReportID>
        <EquipmentID>0</EquipmentID>
        <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
        <FormLine>String</FormLine>
        <IsCustom>false</IsCustom>
        <IsOpen>false</IsOpen>
        <ItemKey>String</ItemKey>
        <Label>String</Label>
        <Note>String</Note>
        <Outcome>String</Outcome>
        <OutcomeNote>String</OutcomeNote>
        <OutcomeText>String</OutcomeText>
        <PhotoCount>0</PhotoCount>
        <Photos>
          <DvirPhotoView>
            <CapturedAtUtc>0001-01-01T00:00:00</CapturedAtUtc>
            <DefectKey>String</DefectKey>
            <Lat>0</Lat>
            <Lng>0</Lng>
            <MarkedUrl>String</MarkedUrl>
            <Url>String</Url>
            <WorkPhotoID>0</WorkPhotoID>
          </DvirPhotoView>
        </Photos>
        <ReportNumber>String</ReportNumber>
        <ReportedAtUtc>0001-01-01T00:00:00</ReportedAtUtc>
        <ReportedByName>String</ReportedByName>
        <ScheduledFor>String</ScheduledFor>
        <Severity>String</Severity>
        <SeverityText>String</SeverityText>
        <SignedOffAtUtc>0001-01-01T00:00:00</SignedOffAtUtc>
        <SignedOffByName>String</SignedOffByName>
        <Source>String</Source>
        <Unit>String</Unit>
        <Withdrawn>false</Withdrawn>
      </DvirDefectView>
    </RecentlyFixed>
    <ReviewReports>
      <DvirReportView>
        <Board>String</Board>
        <Chip>String</Chip>
        <ContactID>0</ContactID>
        <Defects>
          <DvirDefectView>
            <ClientKey>String</ClientKey>
            <DvirDefectID>0</DvirDefectID>
            <DvirReportID>0</DvirReportID>
            <EquipmentID>0</EquipmentID>
            <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
            <FormLine>String</FormLine>
            <IsCustom>false</IsCustom>
            <IsOpen>false</IsOpen>
            <ItemKey>String</ItemKey>
            <Label>String</Label>
            <Note>String</Note>
            <Outcome>String</Outcome>
            <OutcomeNote>String</OutcomeNote>
            <OutcomeText>String</OutcomeText>
            <PhotoCount>0</PhotoCount>
            <Photos>
              <DvirPhotoView>
                <CapturedAtUtc>0001-01-01T00:00:00</CapturedAtUtc>
                <DefectKey>String</DefectKey>
                <Lat>0</Lat>
                <Lng>0</Lng>
                <MarkedUrl>String</MarkedUrl>
                <Url>String</Url>
                <WorkPhotoID>0</WorkPhotoID>
              </DvirPhotoView>
            </Photos>
            <ReportNumber>String</ReportNumber>
            <ReportedAtUtc>0001-01-01T00:00:00</ReportedAtUtc>
            <ReportedByName>String</ReportedByName>
            <ScheduledFor>String</ScheduledFor>
            <Severity>String</Severity>
            <SeverityText>String</SeverityText>
            <SignedOffAtUtc>0001-01-01T00:00:00</SignedOffAtUtc>
            <SignedOffByName>String</SignedOffByName>
            <Source>String</Source>
            <Unit>String</Unit>
            <Withdrawn>false</Withdrawn>
          </DvirDefectView>
        </Defects>
        <DriverName>String</DriverName>
        <DvirReportID>0</DvirReportID>
        <EquipmentID>0</EquipmentID>
        <FiledAtUtc>0001-01-01T00:00:00</FiledAtUtc>
        <ForDate>String</ForDate>
        <IsAway>false</IsAway>
        <IsLate>false</IsLate>
        <IsSatisfactory>false</IsSatisfactory>
        <Kind>String</Kind>
        <KindText>String</KindText>
        <LocationText>String</LocationText>
        <Number>String</Number>
        <Odometer>0</Odometer>
        <Remarks>String</Remarks>
        <ReviewedAtUtc>0001-01-01T00:00:00</ReviewedAtUtc>
        <ReviewedByName>String</ReviewedByName>
        <SavedAtUtc>0001-01-01T00:00:00</SavedAtUtc>
        <Signatures>
          <DvirSignatureView>
            <ImageUrl>String</ImageUrl>
            <Role>String</Role>
            <SignatureRecordID>0</SignatureRecordID>
            <SignedAt>0001-01-01T00:00:00</SignedAt>
            <SignerName>String</SignerName>
          </DvirSignatureView>
        </Signatures>
        <Trailers>
          <DvirUnitRef>
            <EquipmentID>0</EquipmentID>
            <Unit>String</Unit>
          </DvirUnitRef>
        </Trailers>
        <Unit>String</Unit>
      </DvirReportView>
    </ReviewReports>
    <VIN>String</VIN>
  </Vehicle>
</EquipmentDvirSignOffResponse>