POST v2/convenience-options/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
market	string	None.
language	string	None.
vehicle	Vehicle	None.
retailer	Retailer	None.
primaryServices	Collection of PrimaryServiceInput	None.
additionalServices	Collection of AdditionalServiceInput	None.

Request Formats

application/json, text/json

Sample:

{
  "market": "sample string 1",
  "language": "sample string 2",
  "vehicle": {
    "vin": "sample string 1",
    "licensePlate": "sample string 2",
    "brand": "sample string 3",
    "type": "sample string 4",
    "modelYear": 5,
    "modelCode": "sample string 6",
    "mileage": {
      "value": 1,
      "unit": "sample string 2"
    }
  },
  "retailer": {
    "parmaPartnerCode": "sample string 1",
    "partnerId": "sample string 2"
  },
  "primaryServices": [
    {
      "type": "sample string 1",
      "providerResourceId": "sample string 2",
      "vst": 3
    },
    {
      "type": "sample string 1",
      "providerResourceId": "sample string 2",
      "vst": 3
    }
  ],
  "additionalServices": [
    {
      "type": "sample string 1",
      "providerResourceId": "sample string 2"
    },
    {
      "type": "sample string 1",
      "providerResourceId": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<GetConvenienceOptionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PlannerAPI.Models">
  <additionalServices>
    <AdditionalServiceInput>
      <providerResourceId>sample string 2</providerResourceId>
      <type>sample string 1</type>
    </AdditionalServiceInput>
    <AdditionalServiceInput>
      <providerResourceId>sample string 2</providerResourceId>
      <type>sample string 1</type>
    </AdditionalServiceInput>
  </additionalServices>
  <language>sample string 2</language>
  <market>sample string 1</market>
  <primaryServices>
    <PrimaryServiceInput>
      <providerResourceId>sample string 2</providerResourceId>
      <type>sample string 1</type>
      <vst>3</vst>
    </PrimaryServiceInput>
    <PrimaryServiceInput>
      <providerResourceId>sample string 2</providerResourceId>
      <type>sample string 1</type>
      <vst>3</vst>
    </PrimaryServiceInput>
  </primaryServices>
  <retailer>
    <parmaPartnerCode>sample string 1</parmaPartnerCode>
    <partnerId>sample string 2</partnerId>
  </retailer>
  <vehicle>
    <brand>sample string 3</brand>
    <licensePlate>sample string 2</licensePlate>
    <mileage>
      <unit>sample string 2</unit>
      <value>1</value>
    </mileage>
    <modelCode>sample string 6</modelCode>
    <modelYear>5</modelYear>
    <type>sample string 4</type>
    <vin>sample string 1</vin>
  </vehicle>
</GetConvenienceOptionsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.