PATCH apioauth/greyfleet/driver

Patch an existing grey fleet driver.

Request Information

URI Parameters

None.

Body Parameters

A GreyFleetDriverRequest

GreyFleetDriverRequest
NameDescriptionTypeAdditional information
vehicle_registration

The vehicle registration

string

None.

insured_for_business

If the vehicle is insured for business use

boolean

None.

insurance_provider

The insurance provider

string

None.

insurance_policy_start_date

When the insurance policy starts

date

None.

insurance_policy_end_date

When the insurance policy ends

date

None.

breakdown_provider

The breakdown provider

string

None.

breakdown_policy_start_date

The breakdown policy start date

date

None.

breakdown_policy_end_date

The breakdown policy end date

date

None.

photo_1_data

The photo 1 data as a Base64 string.

string

None.

photo_1_name

The name of the photo 1

string

None.

photo_2_data

The photo 2 data as a Base64 string

string

None.

photo_2_name

The name of the photo 2

string

None.

photo_3_data

The photo 3 data as a Base64 string

string

None.

photo_3_name

The name of the photo 3

string

None.

photo_4_data

The photo 4 data as a Base64 string

string

None.

photo_4_name

The name of the photo 4

string

None.

photo_5_data

The photo 5 data as a Base64 string

string

None.

photo_5_name

The name of the photo 5

string

None.

Request Formats

application/json, text/json

Sample:
{
  "vehicle_registration": "sample string 1",
  "insured_for_business": true,
  "insurance_provider": "sample string 2",
  "insurance_policy_start_date": "2025-04-27T15:35:29.2733916+00:00",
  "insurance_policy_end_date": "2025-04-27T15:35:29.2733916+00:00",
  "breakdown_provider": "sample string 3",
  "breakdown_policy_start_date": "2025-04-27T15:35:29.2733916+00:00",
  "breakdown_policy_end_date": "2025-04-27T15:35:29.2733916+00:00",
  "photo_1_data": "sample string 4",
  "photo_1_name": "sample string 5",
  "photo_2_data": "sample string 6",
  "photo_2_name": "sample string 7",
  "photo_3_data": "sample string 8",
  "photo_3_name": "sample string 9",
  "photo_4_data": "sample string 10",
  "photo_4_name": "sample string 11",
  "photo_5_data": "sample string 12",
  "photo_5_name": "sample string 13"
}

application/xml, text/xml

Sample:
<GreyFleetDriverRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VehicleRegistration>sample string 1</VehicleRegistration>
  <InsuredForBusiness>true</InsuredForBusiness>
  <InsuranceProvider>sample string 2</InsuranceProvider>
  <InsurancePolicyStartDate>2025-04-27T15:35:29.2733916+00:00</InsurancePolicyStartDate>
  <InsurancePolicyEndDate>2025-04-27T15:35:29.2733916+00:00</InsurancePolicyEndDate>
  <BreakdownProvider>sample string 3</BreakdownProvider>
  <BreakdownPolicyStartDate>2025-04-27T15:35:29.2733916+00:00</BreakdownPolicyStartDate>
  <BreakdownPolicyEndDate>2025-04-27T15:35:29.2733916+00:00</BreakdownPolicyEndDate>
  <Photo1Data>sample string 4</Photo1Data>
  <Photo1Name>sample string 5</Photo1Name>
  <Photo2Data>sample string 6</Photo2Data>
  <Photo2Name>sample string 7</Photo2Name>
  <Photo3Data>sample string 8</Photo3Data>
  <Photo3Name>sample string 9</Photo3Name>
  <Photo4Data>sample string 10</Photo4Data>
  <Photo4Name>sample string 11</Photo4Name>
  <Photo5Data>sample string 12</Photo5Data>
  <Photo5Name>sample string 13</Photo5Name>
</GreyFleetDriverRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A GreyFleetDriverResponse

GreyFleetDriverResponse
NameDescriptionTypeAdditional information
vehicle_registration

The vehicle registration

string

None.

insured_for_business

If the vehicle is insured for business use

boolean

None.

insurance_provider

The insurance provider

string

None.

insurance_policy_start_date

When the insurance policy starts

date

None.

insurance_policy_end_date

When the insurance policy ends

date

None.

breakdown_provider

The breakdown provider

string

None.

breakdown_policy_start_date

The breakdown policy start date

date

None.

breakdown_policy_end_date

The breakdown policy end date

date

None.

photo_1_url

Photo 1 url

string

None.

photo_2_url

Photo 2 url

string

None.

photo_3_url

Photo 3 url

string

None.

photo_4_url

Photo 4 url

string

None.

photo_5_url

Photo 5 url

string

None.

mot_renewal_date

When the mot is due

date

None.

road_tax_renewal_date

When the road tax is due

date

None.

Response Formats

application/json, text/json

Sample:
{
  "vehicle_registration": "sample string 1",
  "insured_for_business": true,
  "insurance_provider": "sample string 2",
  "insurance_policy_start_date": "2025-04-27T15:35:29.2890198+00:00",
  "insurance_policy_end_date": "2025-04-27T15:35:29.2890198+00:00",
  "breakdown_provider": "sample string 3",
  "breakdown_policy_start_date": "2025-04-27T15:35:29.2890198+00:00",
  "breakdown_policy_end_date": "2025-04-27T15:35:29.2890198+00:00",
  "photo_1_url": "sample string 4",
  "photo_2_url": "sample string 5",
  "photo_3_url": "sample string 6",
  "photo_4_url": "sample string 7",
  "photo_5_url": "sample string 8",
  "mot_renewal_date": "2025-04-27T15:35:29.2890198+00:00",
  "road_tax_renewal_date": "2025-04-27T15:35:29.2890198+00:00"
}

application/xml, text/xml

Sample:
<GreyFleetDriverResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VehicleRegistration>sample string 1</VehicleRegistration>
  <InsuredForBusiness>true</InsuredForBusiness>
  <InsuranceProvider>sample string 2</InsuranceProvider>
  <InsurancePolicyStartDate>2025-04-27T15:35:29.2890198+00:00</InsurancePolicyStartDate>
  <InsurancePolicyEndDate>2025-04-27T15:35:29.2890198+00:00</InsurancePolicyEndDate>
  <BreakdownProvider>sample string 3</BreakdownProvider>
  <BreakdownPolicyStartDate>2025-04-27T15:35:29.2890198+00:00</BreakdownPolicyStartDate>
  <BreakdownPolicyEndDate>2025-04-27T15:35:29.2890198+00:00</BreakdownPolicyEndDate>
  <Photo1Url>sample string 4</Photo1Url>
  <Photo2Url>sample string 5</Photo2Url>
  <Photo3Url>sample string 6</Photo3Url>
  <Photo4Url>sample string 7</Photo4Url>
  <Photo5Url>sample string 8</Photo5Url>
  <MotRenewalDate>2025-04-27T15:35:29.2890198+00:00</MotRenewalDate>
  <RoadTaxRenewalDate>2025-04-27T15:35:29.2890198+00:00</RoadTaxRenewalDate>
</GreyFleetDriverResponse>