ConsumerApi

<back to all web services

AddSavedSearchRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
POST/searches/AddSavedSearch
<?php namespace ConsumerApi;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum Parking : string
{
    case StreetParking = 'StreetParking';
    case ParkingGarageNearby = 'ParkingGarageNearby';
}

enum PaymentOption : string
{
    case Visa = 'Visa';
    case MasterCard = 'MasterCard';
    case AmericanExpress = 'AmericanExpress';
    case Diners = 'Diners';
    case Vipps = 'Vipps';
}

enum PriceMainDish : string
{
    case Value = 'Value';
    case Medium = 'Medium';
    case High = 'High';
    case FineDining = 'FineDining';
}

enum DayOfWeek : string
{
    case Sunday = 'Sunday';
    case Monday = 'Monday';
    case Tuesday = 'Tuesday';
    case Wednesday = 'Wednesday';
    case Thursday = 'Thursday';
    case Friday = 'Friday';
    case Saturday = 'Saturday';
}

class OpenAtTimeDto implements JsonSerializable
{
    public function __construct(
        /** @var DayOfWeek|null */
        public ?DayOfWeek $weekDay=null,
        /** @var int */
        public int $hour=0,
        /** @var int */
        public int $minute=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['weekDay'])) $this->weekDay = JsonConverters::from('DayOfWeek', $o['weekDay']);
        if (isset($o['hour'])) $this->hour = $o['hour'];
        if (isset($o['minute'])) $this->minute = $o['minute'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->weekDay)) $o['weekDay'] = JsonConverters::to('DayOfWeek', $this->weekDay);
        if (isset($this->hour)) $o['hour'] = $this->hour;
        if (isset($this->minute)) $o['minute'] = $this->minute;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddSavedSearchRequest 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.

POST /searches/AddSavedSearch HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddSavedSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <Filter>
    <AdMessageGuid>00000000-0000-0000-0000-000000000000</AdMessageGuid>
    <BarSpecialitySlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </BarSpecialitySlugs>
    <BarTypeSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </BarTypeSlugs>
    <BrandNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </BrandNames>
    <CategoryAbsoluteSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </CategoryAbsoluteSlugs>
    <CuisineSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </CuisineSlugs>
    <EatingSuitabilitySlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </EatingSuitabilitySlugs>
    <MealTypeSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </MealTypeSlugs>
    <OpenAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Hour>0</d3p1:Hour>
      <d3p1:Minute>0</d3p1:Minute>
      <d3p1:WeekDay>Sunday</d3p1:WeekDay>
    </OpenAt>
    <OutdoorSeating>false</OutdoorSeating>
    <Parking xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Database">
      <d3p1:Parking>StreetParking</d3p1:Parking>
    </Parking>
    <PaymentOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Database">
      <d3p1:PaymentOption>Visa</d3p1:PaymentOption>
    </PaymentOptions>
    <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
    <PriceMainDishes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Database">
      <d3p1:PriceMainDish>Value</d3p1:PriceMainDish>
    </PriceMainDishes>
    <SaveFoodAndMoney>false</SaveFoodAndMoney>
    <TakeAwaySlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </TakeAwaySlugs>
    <Term>String</Term>
    <WearPriceProfileSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </WearPriceProfileSlugs>
    <WheelChairAccessible>false</WheelChairAccessible>
    <Wifi>false</Wifi>
  </Filter>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <SearchRadiusInKm>0</SearchRadiusInKm>
  </Location>
  <Name>String</Name>
</AddSavedSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddSavedSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <SavedSearchId>0</SavedSearchId>
</AddSavedSearchResponse>