POST api/mileagereimbursement/{clientId}/driver?isSelf={isSelf}&failOnWarnings={failOnWarnings}

Creates a mileage reimbursement/family friend driver for the given client with the given driver info. If attachments are included in driver request they will be added after successful creation of a driver.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client id that the driver will be attached to	integer	Required
isSelf	Boolean representing if the client is adding themselves as a driver or some other family/friend	boolean	Required
failOnWarnings	Boolean to error on warning as well as errors	boolean	Default value is False

Body Parameters

The driver info for the new driver

MileageReimbursementDriverRequest

Name	Description	Type	Additional information
Driver	Gets or sets the driver	MileageReimbursementDriver	None.
NewAttachments	Optional: Gets or sets the new attachments to add. Default value of a new list of attachments.	Collection of Attachment	None.

Request Formats

application/json, text/json

Sample:

{
  "driver": {
    "driverLicenceExp": "2025-12-10T06:34:07.0164585-07:00",
    "driverLicenceNumber": "sample string 1",
    "driverLicenceIssuer": "sample string 2",
    "personId": 3,
    "firstName": "sample string 4",
    "middleName": "sample string 5",
    "lastName": "sample string 6",
    "birthDate": "2025-12-10T06:34:07.0164585-07:00"
  },
  "newAttachments": [
    {
      "fileId": 1,
      "name": "sample string 2",
      "fileType": "sample string 3",
      "fileSize": 1,
      "fileData": "sample string 4",
      "description": "sample string 5",
      "fileMark": 0
    },
    {
      "fileId": 1,
      "name": "sample string 2",
      "fileType": "sample string 3",
      "fileSize": 1,
      "fileData": "sample string 4",
      "description": "sample string 5",
      "fileMark": 0
    }
  ]
}

application/xml, text/xml

Sample:

<MileageReimbursementDriverRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Driver>
    <BirthDate>2025-12-10T06:34:07.0164585-07:00</BirthDate>
    <DriverLicenceExp>2025-12-10T06:34:07.0164585-07:00</DriverLicenceExp>
    <DriverLicenceIssuer>sample string 2</DriverLicenceIssuer>
    <DriverLicenceNumber>sample string 1</DriverLicenceNumber>
    <FirstName>sample string 4</FirstName>
    <LastName>sample string 6</LastName>
    <MiddleName>sample string 5</MiddleName>
    <PersonId>3</PersonId>
  </Driver>
  <NewAttachments>
    <Attachment>
      <Description>sample string 5</Description>
      <FileData>sample string 4</FileData>
      <FileId>1</FileId>
      <FileMark>MarkedAsOriginal</FileMark>
      <FileSize>1</FileSize>
      <FileType>sample string 3</FileType>
      <Name>sample string 2</Name>
    </Attachment>
    <Attachment>
      <Description>sample string 5</Description>
      <FileData>sample string 4</FileData>
      <FileId>1</FileId>
      <FileMark>MarkedAsOriginal</FileMark>
      <FileSize>1</FileSize>
      <FileType>sample string 3</FileType>
      <Name>sample string 2</Name>
    </Attachment>
  </NewAttachments>
</MileageReimbursementDriverRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Mileage Reimbursement (Friends and Family) drivers

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.