BusinessApi

<back to all web services

GetAdsRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/ad/get_all

export module BusinessApi
{
    // @ts-nocheck

    export enum VisibilityState
    {
        Draft = 'Draft',
        Running = 'Running',
        Upcoming = 'Upcoming',
        Archived = 'Archived',
        Paused = 'Paused',
    }

    export class ImageUrls
    {
        public preview: string;
        public small: string;
        public medium: string;
        public large: string;

        public constructor(init?: Partial<ImageUrls>) { (Object as any).assign(this, init); }
    }

    export class OpeningHour
    {
        public openAtHour?: number;
        public openAtMinute?: number;
        public closeAtHour?: number;
        public closeAtMinute?: number;

        public constructor(init?: Partial<OpeningHour>) { (Object as any).assign(this, init); }
    }

    export class WeeklyOpeningHours
    {
        public monday?: OpeningHour;
        public tuesday?: OpeningHour;
        public wednesday?: OpeningHour;
        public thursday?: OpeningHour;
        public friday?: OpeningHour;
        public saturday?: OpeningHour;
        public sunday?: OpeningHour;

        public constructor(init?: Partial<WeeklyOpeningHours>) { (Object as any).assign(this, init); }
    }

    export class OpeningHours
    {
        public weekly: WeeklyOpeningHours;

        public constructor(init?: Partial<OpeningHours>) { (Object as any).assign(this, init); }
    }

    export enum PlaceType
    {
        Mall = 'Mall',
        Regular = 'Regular',
    }

    export class PlaceContact
    {
        public phone?: string;
        public email?: string;
        public website?: string;
        public webShop?: string;

        public constructor(init?: Partial<PlaceContact>) { (Object as any).assign(this, init); }
    }

    export class PlaceAddress
    {
        public street: string;
        public postalCode: string;
        public region: string;
        public countryCode: string;

        public constructor(init?: Partial<PlaceAddress>) { (Object as any).assign(this, init); }
    }

    export class TimeZoneDto
    {
        public baseUtcOffset?: string;
        public daylightName: string;
        public displayName: string;
        public id: string;
        public standardName: string;
        public supportsDaylightSavingTime?: boolean;

        public constructor(init?: Partial<TimeZoneDto>) { (Object as any).assign(this, init); }
    }

    export enum PriceMainDish
    {
        Value = 'Value',
        Medium = 'Medium',
        High = 'High',
        FineDining = 'FineDining',
    }

    export class PriceMainDishDto
    {
        public title: string;
        public slug?: PriceMainDish;

        public constructor(init?: Partial<PriceMainDishDto>) { (Object as any).assign(this, init); }
    }

    export class AdDetailsBase
    {
        public description?: string;
        public moreInformation?: string[] = [];

        public constructor(init?: Partial<AdDetailsBase>) { (Object as any).assign(this, init); }
    }

    export class AdDetailsPercentageDiscountOnAllMerchandise extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsPercentageDiscountOnAllMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsPercentageDiscountRangeOnAllMerchandise extends AdDetailsBase
    {
        public start?: number;
        public stop?: number;

        public constructor(init?: Partial<AdDetailsPercentageDiscountRangeOnAllMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsPercentageDiscountOnSelectedMerchandise extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsPercentageDiscountOnSelectedMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsAbsoluteDiscountOnSelectedMerchandise extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsAbsoluteDiscountOnSelectedMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdDetailsBase
    {
        public start?: number;
        public stop?: number;

        public constructor(init?: Partial<AdDetailsAbsoluteDiscountRangeOnAllMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsTotalAmountOverXgivesYdiscount extends AdDetailsBase
    {
        public ifTotalAmountMoreThanX?: number;
        public thenYouGetDiscountPercentageY?: number;

        public constructor(init?: Partial<AdDetailsTotalAmountOverXgivesYdiscount>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsXforYdiscount extends AdDetailsBase
    {
        public ifYouBuyX?: number;
        public thenYouGetY?: number;

        public constructor(init?: Partial<AdDetailsXforYdiscount>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsNewArrivals extends AdDetailsBase
    {

        public constructor(init?: Partial<AdDetailsNewArrivals>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsFreetext extends AdDetailsBase
    {
        public title: string;

        public constructor(init?: Partial<AdDetailsFreetext>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsTodaysBreakFastOffer extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsTodaysBreakFastOffer>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsTodaysLunchOffer extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsTodaysLunchOffer>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsTodaysDinnerOffer extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsTodaysDinnerOffer>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsSaveFoodAndMoney extends AdDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdDetailsSaveFoodAndMoney>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsPercentageOffYourFoodBill extends AdDetailsBase
    {
        public percentage?: number;

        public constructor(init?: Partial<AdDetailsPercentageOffYourFoodBill>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsHappyHour extends AdDetailsBase
    {

        public constructor(init?: Partial<AdDetailsHappyHour>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsSomeFreeTablesLeftToday extends AdDetailsBase
    {

        public constructor(init?: Partial<AdDetailsSomeFreeTablesLeftToday>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsTwoDishesForThePriceOfOne extends AdDetailsBase
    {

        public constructor(init?: Partial<AdDetailsTwoDishesForThePriceOfOne>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdDetailsUnion
    {
        public percentageOnAllMerchandise?: AdDetailsPercentageDiscountOnAllMerchandise;
        public percentageRangeOnAllMerchandise?: AdDetailsPercentageDiscountRangeOnAllMerchandise;
        public percentageOnSelectedMerchandise?: AdDetailsPercentageDiscountOnSelectedMerchandise;
        public absoluteOnSelectedMerchandise?: AdDetailsAbsoluteDiscountOnSelectedMerchandise;
        public absoluteRangeOnAllMerchandise?: AdDetailsAbsoluteDiscountRangeOnAllMerchandise;
        public totalAmountOverXgivesYdiscount?: AdDetailsTotalAmountOverXgivesYdiscount;
        public xforY?: AdDetailsXforYdiscount;
        public newArrivals?: AdDetailsNewArrivals;
        public freetext?: AdDetailsFreetext;
        public todaysBreakFastOffer?: AdDetailsTodaysBreakFastOffer;
        public todaysLunchOffer?: AdDetailsTodaysLunchOffer;
        public todaysDinnerOffer?: AdDetailsTodaysDinnerOffer;
        public saveFoodAndMoney?: AdDetailsSaveFoodAndMoney;
        public percentageOfYourFoodBill?: AdDetailsPercentageOffYourFoodBill;
        public happyHour?: AdDetailsHappyHour;
        public someFreeTablesLeftToday?: AdDetailsSomeFreeTablesLeftToday;
        public twoDishesForThePriceOfOne?: AdDetailsTwoDishesForThePriceOfOne;

        public constructor(init?: Partial<AdDetailsUnion>) { (Object as any).assign(this, init); }
    }

}

TypeScript GetAdsRequest 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 /ad/get_all HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAdsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdsWithVisibilityState>
    <BusinessAdDto>
      <DetailsUnion xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:AbsoluteOnSelectedMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:AbsoluteOnSelectedMerchandise>
        <d4p1:AbsoluteRangeOnAllMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Start>0</d4p1:Start>
          <d4p1:Stop>0</d4p1:Stop>
        </d4p1:AbsoluteRangeOnAllMerchandise>
        <d4p1:Freetext>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Title>String</d4p1:Title>
        </d4p1:Freetext>
        <d4p1:HappyHour>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:HappyHour>
        <d4p1:NewArrivals>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:NewArrivals>
        <d4p1:PercentageOfYourFoodBill>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Percentage>0</d4p1:Percentage>
        </d4p1:PercentageOfYourFoodBill>
        <d4p1:PercentageOnAllMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:PercentageOnAllMerchandise>
        <d4p1:PercentageOnSelectedMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:PercentageOnSelectedMerchandise>
        <d4p1:PercentageRangeOnAllMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Start>0</d4p1:Start>
          <d4p1:Stop>0</d4p1:Stop>
        </d4p1:PercentageRangeOnAllMerchandise>
        <d4p1:SaveFoodAndMoney>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:SaveFoodAndMoney>
        <d4p1:SomeFreeTablesLeftToday>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:SomeFreeTablesLeftToday>
        <d4p1:TodaysBreakFastOffer>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:TodaysBreakFastOffer>
        <d4p1:TodaysDinnerOffer>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:TodaysDinnerOffer>
        <d4p1:TodaysLunchOffer>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:TodaysLunchOffer>
        <d4p1:TotalAmountOverXgivesYdiscount>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:IfTotalAmountMoreThanX>0</d4p1:IfTotalAmountMoreThanX>
          <d4p1:ThenYouGetDiscountPercentageY>0</d4p1:ThenYouGetDiscountPercentageY>
        </d4p1:TotalAmountOverXgivesYdiscount>
        <d4p1:TwoDishesForThePriceOfOne>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:TwoDishesForThePriceOfOne>
        <d4p1:XforY>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:IfYouBuyX>0</d4p1:IfYouBuyX>
          <d4p1:ThenYouGetY>0</d4p1:ThenYouGetY>
        </d4p1:XforY>
      </DetailsUnion>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <ImageUrls xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:ImageUrls>
          <d4p1:Large>String</d4p1:Large>
          <d4p1:Medium>String</d4p1:Medium>
          <d4p1:Preview>String</d4p1:Preview>
          <d4p1:Small>String</d4p1:Small>
        </d4p1:ImageUrls>
      </ImageUrls>
      <Place>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:CountryCode>String</d5p1:CountryCode>
          <d5p1:PostalCode>String</d5p1:PostalCode>
          <d5p1:Region>String</d5p1:Region>
          <d5p1:Street>String</d5p1:Street>
        </Address>
        <BusinessId>0</BusinessId>
        <Claimed>false</Claimed>
        <Contact xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Email>String</d5p1:Email>
          <d5p1:Phone>String</d5p1:Phone>
          <d5p1:WebShop>String</d5p1:WebShop>
          <d5p1:Website>String</d5p1:Website>
        </Contact>
        <CountryCode>String</CountryCode>
        <Floor>String</Floor>
        <Guid>00000000-0000-0000-0000-000000000000</Guid>
        <Id>0</Id>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
        <Name>String</Name>
        <OpeningHours xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Weekly>
            <d5p1:Friday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Friday>
            <d5p1:Monday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Monday>
            <d5p1:Saturday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Saturday>
            <d5p1:Sunday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Sunday>
            <d5p1:Thursday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Thursday>
            <d5p1:Tuesday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Tuesday>
            <d5p1:Wednesday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Wednesday>
          </d5p1:Weekly>
        </OpeningHours>
        <OrganizationNumber>String</OrganizationNumber>
        <OtherServices>
          <MallOtherServiceDto>
            <Floor>String</Floor>
            <Id>0</Id>
            <ServiceName>String</ServiceName>
          </MallOtherServiceDto>
        </OtherServices>
        <OutdoorSeating>false</OutdoorSeating>
        <Overview>String</Overview>
        <PlaceType>Mall</PlaceType>
        <PriceMainDish xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Slug>Value</d5p1:Slug>
          <d5p1:Title>String</d5p1:Title>
        </PriceMainDish>
        <SaveFoodAndMoney>false</SaveFoodAndMoney>
        <TimeZoneDto xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:BaseUtcOffset>PT0S</d5p1:BaseUtcOffset>
          <d5p1:DaylightName>String</d5p1:DaylightName>
          <d5p1:DisplayName>String</d5p1:DisplayName>
          <d5p1:Id>String</d5p1:Id>
          <d5p1:StandardName>String</d5p1:StandardName>
          <d5p1:SupportsDaylightSavingTime>false</d5p1:SupportsDaylightSavingTime>
        </TimeZoneDto>
        <WheelChairAccessible>false</WheelChairAccessible>
        <Wifi>false</Wifi>
      </Place>
      <PublishAt>
        <Day>0</Day>
        <Hour>0</Hour>
        <Minute>0</Minute>
        <Month>0</Month>
        <Second>0</Second>
        <Year>0</Year>
      </PublishAt>
      <StartAt>
        <Day>0</Day>
        <Hour>0</Hour>
        <Minute>0</Minute>
        <Month>0</Month>
        <Second>0</Second>
        <Year>0</Year>
      </StartAt>
      <State>String</State>
      <StopAt>
        <Day>0</Day>
        <Hour>0</Hour>
        <Minute>0</Minute>
        <Month>0</Month>
        <Second>0</Second>
        <Year>0</Year>
      </StopAt>
      <Title>String</Title>
      <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>
    </BusinessAdDto>
  </AdsWithVisibilityState>
</GetAdsResponse>