ConsumerApi

<back to all web services

GetSavedSearchesRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/searches/GetSavedSearches
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module ConsumerApi


class Parking(str, Enum):
    STREET_PARKING = 'StreetParking'
    PARKING_GARAGE_NEARBY = 'ParkingGarageNearby'


class PaymentOption(str, Enum):
    VISA = 'Visa'
    MASTER_CARD = 'MasterCard'
    AMERICAN_EXPRESS = 'AmericanExpress'
    DINERS = 'Diners'
    VIPPS = 'Vipps'


class PriceMainDish(str, Enum):
    VALUE = 'Value'
    MEDIUM = 'Medium'
    HIGH = 'High'
    FINE_DINING = 'FineDining'


class DayOfWeek(str, Enum):
    SUNDAY = 'Sunday'
    MONDAY = 'Monday'
    TUESDAY = 'Tuesday'
    WEDNESDAY = 'Wednesday'
    THURSDAY = 'Thursday'
    FRIDAY = 'Friday'
    SATURDAY = 'Saturday'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OpenAtTimeDto:
    week_day: Optional[DayOfWeek] = None
    hour: int = 0
    minute: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CategoryDto:
    name: Optional[str] = None
    slug: Optional[str] = None
    absolute_slug: Optional[str] = None
    image_url: Optional[str] = None
    all_image_url: Optional[str] = None
    icon_image_url: Optional[str] = None
    position: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BarSpecialityEsDto:
    slug: Optional[str] = None
    title: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BarTypeEsDto:
    slug: Optional[str] = None
    title: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrandApiDto:
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CuisineEsDto:
    label: Optional[str] = None
    slug: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MealTypeApiDto:
    label: Optional[str] = None
    slug: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ParkingApiDto:
    label: Optional[str] = None
    slug: Optional[Parking] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentOptionApiDto:
    label: Optional[str] = None
    slug: Optional[PaymentOption] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PriceMainDishApiDto:
    title: Optional[str] = None
    slug: Optional[PriceMainDish] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EatingSuitabilityApiDto:
    label: Optional[str] = None
    slug: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TakeAwayApiDto:
    label: Optional[str] = None
    slug: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WearPriceProfileEsDto:
    slug: Optional[str] = None
    label: Optional[str] = None


Python GetSavedSearchesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /searches/GetSavedSearches HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSavedSearchesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <Searches>
    <SavedSearchDto>
      <CreatedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedAt>
      <Filter>
        <AdMessageGuid>00000000-0000-0000-0000-000000000000</AdMessageGuid>
        <BarSpecialitySlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </BarSpecialitySlugs>
        <BarTypeSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </BarTypeSlugs>
        <BrandNames xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </BrandNames>
        <CategoryAbsoluteSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </CategoryAbsoluteSlugs>
        <CuisineSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </CuisineSlugs>
        <EatingSuitabilitySlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </EatingSuitabilitySlugs>
        <MealTypeSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </MealTypeSlugs>
        <OpenAt xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Hour>0</d5p1:Hour>
          <d5p1:Minute>0</d5p1:Minute>
          <d5p1:WeekDay>Sunday</d5p1:WeekDay>
        </OpenAt>
        <OutdoorSeating>false</OutdoorSeating>
        <Parking xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Database">
          <d5p1:Parking>StreetParking</d5p1:Parking>
        </Parking>
        <PaymentOptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Database">
          <d5p1:PaymentOption>Visa</d5p1:PaymentOption>
        </PaymentOptions>
        <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
        <PriceMainDishes xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Database">
          <d5p1:PriceMainDish>Value</d5p1:PriceMainDish>
        </PriceMainDishes>
        <SaveFoodAndMoney>false</SaveFoodAndMoney>
        <TakeAwaySlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </TakeAwaySlugs>
        <Term>String</Term>
        <WearPriceProfileSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </WearPriceProfileSlugs>
        <WheelChairAccessible>false</WheelChairAccessible>
        <Wifi>false</Wifi>
      </Filter>
      <FilterDetails>
        <BarSpecialities xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:BarSpecialityEsDto>
            <d5p1:Slug>String</d5p1:Slug>
            <d5p1:Title>String</d5p1:Title>
          </d5p1:BarSpecialityEsDto>
        </BarSpecialities>
        <BarTypes xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:BarTypeEsDto>
            <d5p1:Slug>String</d5p1:Slug>
            <d5p1:Title>String</d5p1:Title>
          </d5p1:BarTypeEsDto>
        </BarTypes>
        <Brands xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:BrandApiDto>
            <d5p1:Name>String</d5p1:Name>
          </d5p1:BrandApiDto>
        </Brands>
        <Categories xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:CategoryDto>
            <d5p1:AbsoluteSlug>String</d5p1:AbsoluteSlug>
            <d5p1:AllImageUrl>String</d5p1:AllImageUrl>
            <d5p1:IconImageUrl>String</d5p1:IconImageUrl>
            <d5p1:ImageUrl>String</d5p1:ImageUrl>
            <d5p1:Name>String</d5p1:Name>
            <d5p1:Position>0</d5p1:Position>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:CategoryDto>
        </Categories>
        <Cuisines xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:CuisineEsDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:CuisineEsDto>
        </Cuisines>
        <EatingSuitability xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:EatingSuitabilityApiDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:EatingSuitabilityApiDto>
        </EatingSuitability>
        <MealTypes xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:MealTypeApiDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:MealTypeApiDto>
        </MealTypes>
        <Parking xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:ParkingApiDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>StreetParking</d5p1:Slug>
          </d5p1:ParkingApiDto>
        </Parking>
        <PaymentOptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:PaymentOptionApiDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>Visa</d5p1:Slug>
          </d5p1:PaymentOptionApiDto>
        </PaymentOptions>
        <PriceMainDishes xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:PriceMainDishApiDto>
            <d5p1:Slug>Value</d5p1:Slug>
            <d5p1:Title>String</d5p1:Title>
          </d5p1:PriceMainDishApiDto>
        </PriceMainDishes>
        <RootCategories xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:CategoryDto>
            <d5p1:AbsoluteSlug>String</d5p1:AbsoluteSlug>
            <d5p1:AllImageUrl>String</d5p1:AllImageUrl>
            <d5p1:IconImageUrl>String</d5p1:IconImageUrl>
            <d5p1:ImageUrl>String</d5p1:ImageUrl>
            <d5p1:Name>String</d5p1:Name>
            <d5p1:Position>0</d5p1:Position>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:CategoryDto>
        </RootCategories>
        <TakeAways xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:TakeAwayApiDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:TakeAwayApiDto>
        </TakeAways>
        <WearPriceProfiles xmlns:d5p1="http://schemas.datacontract.org/2004/07/Api.Dto">
          <d5p1:WearPriceProfileEsDto>
            <d5p1:Label>String</d5p1:Label>
            <d5p1:Slug>String</d5p1:Slug>
          </d5p1:WearPriceProfileEsDto>
        </WearPriceProfiles>
      </FilterDetails>
      <Id>0</Id>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
        <SearchRadiusInKm>0</SearchRadiusInKm>
      </Location>
      <Name>String</Name>
      <UpdatedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </UpdatedAt>
    </SavedSearchDto>
  </Searches>
</GetSavedSearchesResponse>