PATCH api/Driver

Patch driver information

Request Information

URI Parameters

None.

Body Parameters

The driver object to patch - DriverID is used as a key, properties not provided will be default to an empty string.

Name	Description	Type	Additional information
DriverID	Unique ID of Driver	integer	None.
DriverCallsign	Driver Callsign	string	String length: inclusive between 0 and 20
DriverName	Driver Name	string	String length: inclusive between 0 and 100
CircuitName	Driver circuit assignment	string	String length: inclusive between 0 and 50
KeyfobNumber	The keyfob number currently assigned to this driver	string	String length: inclusive between 0 and 12
TachoCardNumber	The digital tachograph card nummber assigned to this driver	string	String length: inclusive between 0 and 14
CircuitId	The circuitId for this driver	integer	None.
TelephoneNumber	The Telephone Number for this driver	string	None.
MobileNumber	The Mobile Number for this driver	string	None.
EmailAddress	The Email Address for this driver	string	None.
Address	The Address for this driver	string	None.
District	The District for this driver	string	None.
Town	The Town for this driver	string	None.
Region	The Region for this driver	string	None.
County	The County for this driver	string	None.
Country	The Country for this driver	string	None.
Postcode	The Postcode for this driver	string	None.
UserPrincipal	The User Principal Name for the Microsoft Entra account linked to this driver	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DriverID": 1,
  "DriverCallsign": "sample string 2",
  "DriverName": "sample string 3",
  "CircuitName": "sample string 4",
  "KeyfobNumber": "sample string 5",
  "TachoCardNumber": "sample string 6",
  "CircuitId": 7,
  "TelephoneNumber": "sample string 8",
  "MobileNumber": "sample string 9",
  "EmailAddress": "sample string 10",
  "Address": "sample string 11",
  "District": "sample string 12",
  "Town": "sample string 13",
  "Region": "sample string 14",
  "County": "sample string 15",
  "Country": "sample string 16",
  "Postcode": "sample string 17",
  "UserPrincipal": "sample string 18"
}

application/xml, text/xml

Sample:

<Driver xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DriverID>1</DriverID>
  <DriverCallsign>sample string 2</DriverCallsign>
  <DriverName>sample string 3</DriverName>
  <CircuitName>sample string 4</CircuitName>
  <KeyfobNumber>sample string 5</KeyfobNumber>
  <TachoCardNumber>sample string 6</TachoCardNumber>
  <CircuitId>7</CircuitId>
  <TelephoneNumber>sample string 8</TelephoneNumber>
  <MobileNumber>sample string 9</MobileNumber>
  <EmailAddress>sample string 10</EmailAddress>
  <Address>sample string 11</Address>
  <District>sample string 12</District>
  <Town>sample string 13</Town>
  <Region>sample string 14</Region>
  <County>sample string 15</County>
  <Country>sample string 16</Country>
  <Postcode>sample string 17</Postcode>
  <UserPrincipal>sample string 18</UserPrincipal>
</Driver>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Driver'.

Response Information

Resource Description

Returns a boolean indicating success.

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean>true</boolean>