POST api/classe/vehiclecheck

Send a completed vehicle check

Request Information

URI Parameters

None.

Body Parameters

The completed vehicle check

CompletedVehicleCheckModel
NameDescriptionTypeAdditional information
Token

The token returned after login used for authentication

 string

None.
DriverId

The driver id returned after login used for authentication

 unsigned integer

None.
VehicleCheckStartedTime

The time when the vehicle check was started

 date

None.
VehicleCheckCompletionTime

The time when the vehicle check was completed

 date

None.
DriverName

The driver name who completed the vehicle check

 string

None.
DriverMobileNumber

The mobile phone of the driver who completed the vehicle check

 string

None.
Region

The region of the driver who completed the vehicle check

 string

None.
ServiceID

The service id of the vehicle the check was done on

 integer

None.
VehicleProvider

The vehicle provider

 string

None.
VehicleMake

The vehicle make

 string

None.
VehicleModel

The vehicle model

 string

None.
VehicleRegistration

The vehicle reg

 string

None.
Mileage

The vehicle mileage

 integer

None.
DriverSignatureS3Key

AWS S3 link to the signature

 string

None.
VehicleCheckSections

The sections of the vehicle check

 Collection of CompletedVehicleCheckSectionModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "Token": "sample string 1",
  "DriverId": 2,
  "VehicleCheckStartedTime": "2025-04-27T15:54:47.8530814+00:00",
  "VehicleCheckCompletionTime": "2025-04-27T15:54:47.8530814+00:00",
  "DriverName": "sample string 5",
  "DriverMobileNumber": "sample string 6",
  "Region": "sample string 7",
  "ServiceID": 8,
  "VehicleProvider": "sample string 9",
  "VehicleMake": "sample string 10",
  "VehicleModel": "sample string 11",
  "VehicleRegistration": "sample string 12",
  "Mileage": 13,
  "DriverSignatureS3Key": "sample string 14",
  "VehicleCheckSections": [
    {
      "SectionID": 1,
      "VehicleCheckItems": [
        {
          "ItemID": 1,
          "Fault": true,
          "NotApplicable": true,
          "FaultDescription": "sample string 4",
          "PhotoS3KeyCollection": [
            "sample string 1",
            "sample string 2"
          ],
          "FaultPhotoS3Key": "sample string 5",
          "Notes": "sample string 6"
        },
        {
          "ItemID": 1,
          "Fault": true,
          "NotApplicable": true,
          "FaultDescription": "sample string 4",
          "PhotoS3KeyCollection": [
            "sample string 1",
            "sample string 2"
          ],
          "FaultPhotoS3Key": "sample string 5",
          "Notes": "sample string 6"
        }
      ]
    },
    {
      "SectionID": 1,
      "VehicleCheckItems": [
        {
          "ItemID": 1,
          "Fault": true,
          "NotApplicable": true,
          "FaultDescription": "sample string 4",
          "PhotoS3KeyCollection": [
            "sample string 1",
            "sample string 2"
          ],
          "FaultPhotoS3Key": "sample string 5",
          "Notes": "sample string 6"
        },
        {
          "ItemID": 1,
          "Fault": true,
          "NotApplicable": true,
          "FaultDescription": "sample string 4",
          "PhotoS3KeyCollection": [
            "sample string 1",
            "sample string 2"
          ],
          "FaultPhotoS3Key": "sample string 5",
          "Notes": "sample string 6"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<CompletedVehicleCheckModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Token>sample string 1</Token>
  <DriverId>2</DriverId>
  <VehicleCheckStartedTime>2025-04-27T15:54:47.8530814+00:00</VehicleCheckStartedTime>
  <VehicleCheckCompletionTime>2025-04-27T15:54:47.8530814+00:00</VehicleCheckCompletionTime>
  <DriverName>sample string 5</DriverName>
  <DriverMobileNumber>sample string 6</DriverMobileNumber>
  <Region>sample string 7</Region>
  <ServiceID>8</ServiceID>
  <VehicleProvider>sample string 9</VehicleProvider>
  <VehicleMake>sample string 10</VehicleMake>
  <VehicleModel>sample string 11</VehicleModel>
  <VehicleRegistration>sample string 12</VehicleRegistration>
  <Mileage>13</Mileage>
  <DriverSignatureS3Key>sample string 14</DriverSignatureS3Key>
  <VehicleCheckSections>
    <CompletedVehicleCheckSectionModel>
      <SectionID>1</SectionID>
      <VehicleCheckItems>
        <CompletedVehicleCheckItemModel>
          <ItemID>1</ItemID>
          <Fault>true</Fault>
          <NotApplicable>true</NotApplicable>
          <FaultDescription>sample string 4</FaultDescription>
          <PhotoS3KeyCollection>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </PhotoS3KeyCollection>
          <FaultPhotoS3Key>sample string 5</FaultPhotoS3Key>
          <Notes>sample string 6</Notes>
        </CompletedVehicleCheckItemModel>
        <CompletedVehicleCheckItemModel>
          <ItemID>1</ItemID>
          <Fault>true</Fault>
          <NotApplicable>true</NotApplicable>
          <FaultDescription>sample string 4</FaultDescription>
          <PhotoS3KeyCollection>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </PhotoS3KeyCollection>
          <FaultPhotoS3Key>sample string 5</FaultPhotoS3Key>
          <Notes>sample string 6</Notes>
        </CompletedVehicleCheckItemModel>
      </VehicleCheckItems>
    </CompletedVehicleCheckSectionModel>
    <CompletedVehicleCheckSectionModel>
      <SectionID>1</SectionID>
      <VehicleCheckItems>
        <CompletedVehicleCheckItemModel>
          <ItemID>1</ItemID>
          <Fault>true</Fault>
          <NotApplicable>true</NotApplicable>
          <FaultDescription>sample string 4</FaultDescription>
          <PhotoS3KeyCollection>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </PhotoS3KeyCollection>
          <FaultPhotoS3Key>sample string 5</FaultPhotoS3Key>
          <Notes>sample string 6</Notes>
        </CompletedVehicleCheckItemModel>
        <CompletedVehicleCheckItemModel>
          <ItemID>1</ItemID>
          <Fault>true</Fault>
          <NotApplicable>true</NotApplicable>
          <FaultDescription>sample string 4</FaultDescription>
          <PhotoS3KeyCollection>
            <string>sample string 1</string>
            <string>sample string 2</string>
          </PhotoS3KeyCollection>
          <FaultPhotoS3Key>sample string 5</FaultPhotoS3Key>
          <Notes>sample string 6</Notes>
        </CompletedVehicleCheckItemModel>
      </VehicleCheckItems>
    </CompletedVehicleCheckSectionModel>
  </VehicleCheckSections>
</CompletedVehicleCheckModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Bool indicating if the check was saved successfully

boolean

Response Formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean>true</boolean>