POST api/showroom/search

Searches the showroom vehicles based on the supplied criteria.

Request Information

URI Parameters

None.

Body Parameters

ERP.Domain.Common.VehicleData.Showroom.VehicleShowroomSearchModel

Name	Type	Additional information
Makes	Collection of string	None.
Doors	Collection of integer	None.
Models	Collection of string	None.
FuelType	Collection of string	None.
MinimumPrice	decimal number	None.
MaximumPrice	decimal number	None.
Transmissions	Collection of string	None.
Colours	Collection of string	None.
MaximumMileage	integer	None.
MinYear	integer	None.
MaxYear	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
SortBy	ERP.Domain.Common.VehicleData.Showroom.VehicleShowroomProperty	None.
SortDescending	boolean	None.
EngineSize	Collection of string	None.
MaxMonthlyPrice	decimal number	None.
BodyTypes	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "makes": [
    "sample string 1",
    "sample string 2"
  ],
  "doors": [
    1,
    2
  ],
  "models": [
    "sample string 1",
    "sample string 2"
  ],
  "fuelType": [
    "sample string 1",
    "sample string 2"
  ],
  "minimumPrice": 1.0,
  "maximumPrice": 1.0,
  "transmissions": [
    "sample string 1",
    "sample string 2"
  ],
  "colours": [
    "sample string 1",
    "sample string 2"
  ],
  "maximumMileage": 1,
  "minYear": 1,
  "maxYear": 1,
  "pageSize": 1,
  "pageNumber": 2,
  "sortBy": 0,
  "sortDescending": true,
  "engineSize": [
    "sample string 1",
    "sample string 2"
  ],
  "maxMonthlyPrice": 1.0,
  "bodyTypes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<VehicleShowroomSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Domain.Common.VehicleData.Showroom">
  <BodyTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BodyTypes>
  <Colours xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Colours>
  <Doors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Doors>
  <EngineSize xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EngineSize>
  <FuelType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FuelType>
  <Makes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Makes>
  <MaxMonthlyPrice>1</MaxMonthlyPrice>
  <MaxYear>1</MaxYear>
  <MaximumMileage>1</MaximumMileage>
  <MaximumPrice>1</MaximumPrice>
  <MinYear>1</MinYear>
  <MinimumPrice>1</MinimumPrice>
  <Models xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Models>
  <PageNumber>2</PageNumber>
  <PageSize>1</PageSize>
  <SortBy>Price</SortBy>
  <SortDescending>true</SortDescending>
  <Transmissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Transmissions>
</VehicleShowroomSearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Domain.Common.VehicleData.Showroom.VehicleShowroomSearchModel'.

Response Information

Resource Description

A sequence of showroom vehicles.

ERP.Api.Models.CustomerPortal.ShowroomPagedResponse

Name	Description	Type	Additional information
Vehicles	Gets or sets the matching vehicles.	Collection of ERP.Api.Models.CustomerPortal.ShowroomVehicleModel	None.
PageSize	Gets or sets the page size.	integer	None.
PageNumber	Gets or sets the page number.	integer	None.
TotalRecords	Gets or sets the total records in all the pages.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "vehicles": [
    {
      "make": "sample string 1",
      "model": "sample string 2",
      "mileage": 1,
      "colour": "sample string 3",
      "registration": "sample string 4",
      "imageUrl_Main": "sample string 5",
      "imageUrl_More1": "sample string 6",
      "imageUrl_More2": "sample string 7",
      "imageUrl_More3": "sample string 8",
      "imageUrl_More4": "sample string 9",
      "imageUrl_More5": "sample string 10",
      "imageUrl_More6": "sample string 11",
      "imageUrl_More7": "sample string 12",
      "imageUrl_More8": "sample string 13",
      "imageUrl_More9": "sample string 14",
      "variant": "sample string 15",
      "registrationYear": 16,
      "doors": 1,
      "transmission": "sample string 17",
      "fuelType": "sample string 18",
      "engineSizeCC": 1,
      "monthlyPrice": 19.0,
      "price": 20.0,
      "description": "sample string 21",
      "bodyType": "sample string 22"
    },
    {
      "make": "sample string 1",
      "model": "sample string 2",
      "mileage": 1,
      "colour": "sample string 3",
      "registration": "sample string 4",
      "imageUrl_Main": "sample string 5",
      "imageUrl_More1": "sample string 6",
      "imageUrl_More2": "sample string 7",
      "imageUrl_More3": "sample string 8",
      "imageUrl_More4": "sample string 9",
      "imageUrl_More5": "sample string 10",
      "imageUrl_More6": "sample string 11",
      "imageUrl_More7": "sample string 12",
      "imageUrl_More8": "sample string 13",
      "imageUrl_More9": "sample string 14",
      "variant": "sample string 15",
      "registrationYear": 16,
      "doors": 1,
      "transmission": "sample string 17",
      "fuelType": "sample string 18",
      "engineSizeCC": 1,
      "monthlyPrice": 19.0,
      "price": 20.0,
      "description": "sample string 21",
      "bodyType": "sample string 22"
    }
  ],
  "pageSize": 1,
  "pageNumber": 2,
  "totalRecords": 3
}

application/xml, text/xml

Sample:

<ShowroomPagedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CustomerPortal">
  <PageNumber>2</PageNumber>
  <PageSize>1</PageSize>
  <TotalRecords>3</TotalRecords>
  <Vehicles>
    <ShowroomVehicleModel>
      <BodyType>sample string 22</BodyType>
      <Colour>sample string 3</Colour>
      <Description>sample string 21</Description>
      <Doors>1</Doors>
      <EngineSizeCC>1</EngineSizeCC>
      <FuelType>sample string 18</FuelType>
      <ImageUrl_Main>sample string 5</ImageUrl_Main>
      <ImageUrl_More1>sample string 6</ImageUrl_More1>
      <ImageUrl_More2>sample string 7</ImageUrl_More2>
      <ImageUrl_More3>sample string 8</ImageUrl_More3>
      <ImageUrl_More4>sample string 9</ImageUrl_More4>
      <ImageUrl_More5>sample string 10</ImageUrl_More5>
      <ImageUrl_More6>sample string 11</ImageUrl_More6>
      <ImageUrl_More7>sample string 12</ImageUrl_More7>
      <ImageUrl_More8>sample string 13</ImageUrl_More8>
      <ImageUrl_More9>sample string 14</ImageUrl_More9>
      <Make>sample string 1</Make>
      <Mileage>1</Mileage>
      <Model>sample string 2</Model>
      <MonthlyPrice>19</MonthlyPrice>
      <Price>20</Price>
      <Registration>sample string 4</Registration>
      <RegistrationYear>16</RegistrationYear>
      <Transmission>sample string 17</Transmission>
      <Variant>sample string 15</Variant>
    </ShowroomVehicleModel>
    <ShowroomVehicleModel>
      <BodyType>sample string 22</BodyType>
      <Colour>sample string 3</Colour>
      <Description>sample string 21</Description>
      <Doors>1</Doors>
      <EngineSizeCC>1</EngineSizeCC>
      <FuelType>sample string 18</FuelType>
      <ImageUrl_Main>sample string 5</ImageUrl_Main>
      <ImageUrl_More1>sample string 6</ImageUrl_More1>
      <ImageUrl_More2>sample string 7</ImageUrl_More2>
      <ImageUrl_More3>sample string 8</ImageUrl_More3>
      <ImageUrl_More4>sample string 9</ImageUrl_More4>
      <ImageUrl_More5>sample string 10</ImageUrl_More5>
      <ImageUrl_More6>sample string 11</ImageUrl_More6>
      <ImageUrl_More7>sample string 12</ImageUrl_More7>
      <ImageUrl_More8>sample string 13</ImageUrl_More8>
      <ImageUrl_More9>sample string 14</ImageUrl_More9>
      <Make>sample string 1</Make>
      <Mileage>1</Mileage>
      <Model>sample string 2</Model>
      <MonthlyPrice>19</MonthlyPrice>
      <Price>20</Price>
      <Registration>sample string 4</Registration>
      <RegistrationYear>16</RegistrationYear>
      <Transmission>sample string 17</Transmission>
      <Variant>sample string 15</Variant>
    </ShowroomVehicleModel>
  </Vehicles>
</ShowroomPagedResponse>