CorridorSearchRequest
The CorridorSearchRequest structure contains information used to search fuel stations along the route.
| Element | Data Type | Mandatory | Description |
|---|---|---|---|
maxResults | Integer | No | The maximum number of results a response can contain. See maxresults for more details. |
offset | Integer | No | A value specifying the index of the first result. The offset together with the "maxresults" value used to support a paging mechanism on search results. See offset for more details. |
fuelType | String | No | Comma separated integers identifying the fuel types or categories included in the response, with an unlimited Number of values. Stations with unknown price information are excluded from the result set by default. When showallstations parameter set to "true" then the result includes all stations within search area. For more information on available fuel types and categories, see Fuel Types and Categories. |
sortKey | String | No | Criteria for sorting a list of search results. The possible values are: • price (available when specifying fueltype as a query parameter, and its value is mapped to a single fuel type)distance (only available for proximity search) sorts by distance to fuel station. |
sortOrder | String | No | The sort order of the results. The possible values are:• asc (ascending) Default: asc • desc (descending) . |
showAllStations | Boolean | No | Also fuel stations with unknown price or fuel type information are in the result set. This parameter works together with fueltype parameter. The possible values are:• true • false Default: false |
imageDimensions | String | No | Request specific maximum size of brand icon image to match UI and bandwidth requirements. The format is that specifies dimension for a scaled image by providing either the desired width, height, or both. Valid elements are:• w\d+ • h\d+ • w\d+-h\d+ Examples:• imagedimensions=w32-h32 • imagedimensions=w300 • imagedimensions=h200 The provided values are upper boundaries for the dimensions of the returned image. The solution never scales up small image and maintains the aspect ratio of the original image. |
brand | String | No | A list of brands to filter the stations in the response. The brand names in the list are comma separated. The result contains only the stations that have brand field that match to the one of those specified in the list. The matching isn't case sensitive. |
corridor | CorridorType | Yes |
Updated last month