POST DutyOfCare/FilterVehicleDocumentsWithLookupInformation

Gets the duty of care documents required when a vehicle has been added.


Parameters

NameDescriptionAdditional information
filterVehicleLookupDocuments
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "VehicleLookupInformation": {
    "Make": "sample string 1",
    "Model": "sample string 2",
    "Registration": "sample string 3",
    "FuelType": 4,
    "EngineSize": 5,
    "VehicleTypeId": 0,
    "TaxExpiry": "sample string 6",
    "IsTaxValid": true,
    "MotStart": "sample string 8",
    "MotExpiry": "sample string 9",
    "IsMotValid": true
  },
  "Documents": [
    {
      "DocumentName": "sample string 1"
    },
    {
      "DocumentName": "sample string 1"
    },
    {
      "DocumentName": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<FilterVehicleLookupDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Vehicles">
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
    <d2p1:DutyOfCareDocument>
      <d2p1:DocumentName>sample string 1</d2p1:DocumentName>
    </d2p1:DutyOfCareDocument>
    <d2p1:DutyOfCareDocument>
      <d2p1:DocumentName>sample string 1</d2p1:DocumentName>
    </d2p1:DutyOfCareDocument>
    <d2p1:DutyOfCareDocument>
      <d2p1:DocumentName>sample string 1</d2p1:DocumentName>
    </d2p1:DutyOfCareDocument>
  </Documents>
  <VehicleLookupInformation>
    <EngineSize>5</EngineSize>
    <FuelType>4</FuelType>
    <IsMotValid>true</IsMotValid>
    <IsTaxValid>true</IsTaxValid>
    <Make>sample string 1</Make>
    <Model>sample string 2</Model>
    <MotExpiry>sample string 9</MotExpiry>
    <MotStart>sample string 8</MotStart>
    <Registration>sample string 3</Registration>
    <TaxExpiry>sample string 6</TaxExpiry>
    <VehicleTypeId>None</VehicleTypeId>
  </VehicleLookupInformation>
</FilterVehicleLookupDocuments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

The VehicleDocumentsRequiredForDOCResponse

application/json, text/json

Sample:
{
  "List": [
    {
      "DocumentName": "sample string 1"
    },
    {
      "DocumentName": "sample string 1"
    },
    {
      "DocumentName": "sample string 1"
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<VehicleDocumentsRequiredForDOCResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
    <d2p1:DutyOfCareDocument>
      <d2p1:DocumentName>sample string 1</d2p1:DocumentName>
    </d2p1:DutyOfCareDocument>
    <d2p1:DutyOfCareDocument>
      <d2p1:DocumentName>sample string 1</d2p1:DocumentName>
    </d2p1:DutyOfCareDocument>
    <d2p1:DutyOfCareDocument>
      <d2p1:DocumentName>sample string 1</d2p1:DocumentName>
    </d2p1:DutyOfCareDocument>
  </List>
</VehicleDocumentsRequiredForDOCResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body