BusinessApi

<back to all web services

CreateAdRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/ad/create
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BusinessApi;

namespace BusinessApi
{
    public partial class AdDetailsAbsoluteDiscountOnSelectedMerchandise
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsAbsoluteDiscountRangeOnAllMerchandise
        : AdDetailsBase
    {
        public double Start { get; set; }
        public double Stop { get; set; }
    }

    public partial class AdDetailsBase
    {
        public string? Description { get; set; }
        public List<string>? MoreInformation { get; set; } = [];
    }

    public partial class AdDetailsFreetext
        : AdDetailsBase
    {
        public string Title { get; set; }
    }

    public partial class AdDetailsHappyHour
        : AdDetailsBase
    {
    }

    public partial class AdDetailsNewArrivals
        : AdDetailsBase
    {
    }

    public partial class AdDetailsPercentageDiscountOnAllMerchandise
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsPercentageDiscountOnSelectedMerchandise
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsPercentageDiscountRangeOnAllMerchandise
        : AdDetailsBase
    {
        public double Start { get; set; }
        public double Stop { get; set; }
    }

    public partial class AdDetailsPercentageOffYourFoodBill
        : AdDetailsBase
    {
        public double Percentage { get; set; }
    }

    public partial class AdDetailsSaveFoodAndMoney
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsSomeFreeTablesLeftToday
        : AdDetailsBase
    {
    }

    public partial class AdDetailsTodaysBreakFastOffer
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsTodaysDinnerOffer
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsTodaysLunchOffer
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsTotalAmountOverXgivesYdiscount
        : AdDetailsBase
    {
        public double IfTotalAmountMoreThanX { get; set; }
        public double ThenYouGetDiscountPercentageY { get; set; }
    }

    public partial class AdDetailsTwoDishesForThePriceOfOne
        : AdDetailsBase
    {
    }

    public partial class AdDetailsUnion
    {
        public AdDetailsPercentageDiscountOnAllMerchandise? PercentageOnAllMerchandise { get; set; }
        public AdDetailsPercentageDiscountRangeOnAllMerchandise? PercentageRangeOnAllMerchandise { get; set; }
        public AdDetailsPercentageDiscountOnSelectedMerchandise? PercentageOnSelectedMerchandise { get; set; }
        public AdDetailsAbsoluteDiscountOnSelectedMerchandise? AbsoluteOnSelectedMerchandise { get; set; }
        public AdDetailsAbsoluteDiscountRangeOnAllMerchandise? AbsoluteRangeOnAllMerchandise { get; set; }
        public AdDetailsTotalAmountOverXgivesYdiscount? TotalAmountOverXgivesYdiscount { get; set; }
        public AdDetailsXforYdiscount? XforY { get; set; }
        public AdDetailsNewArrivals? NewArrivals { get; set; }
        public AdDetailsFreetext? Freetext { get; set; }
        public AdDetailsTodaysBreakFastOffer? TodaysBreakFastOffer { get; set; }
        public AdDetailsTodaysLunchOffer? TodaysLunchOffer { get; set; }
        public AdDetailsTodaysDinnerOffer? TodaysDinnerOffer { get; set; }
        public AdDetailsSaveFoodAndMoney? SaveFoodAndMoney { get; set; }
        public AdDetailsPercentageOffYourFoodBill? PercentageOfYourFoodBill { get; set; }
        public AdDetailsHappyHour? HappyHour { get; set; }
        public AdDetailsSomeFreeTablesLeftToday? SomeFreeTablesLeftToday { get; set; }
        public AdDetailsTwoDishesForThePriceOfOne? TwoDishesForThePriceOfOne { get; set; }
    }

    public partial class AdDetailsXforYdiscount
        : AdDetailsBase
    {
        public int IfYouBuyX { get; set; }
        public int ThenYouGetY { get; set; }
    }

}

C# CreateAdRequest 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 /ad/create HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateAdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <DetailsUnion xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:AbsoluteOnSelectedMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:AbsoluteOnSelectedMerchandise>
    <d2p1:AbsoluteRangeOnAllMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Start>0</d2p1:Start>
      <d2p1:Stop>0</d2p1:Stop>
    </d2p1:AbsoluteRangeOnAllMerchandise>
    <d2p1:Freetext>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:Freetext>
    <d2p1:HappyHour>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:HappyHour>
    <d2p1:NewArrivals>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:NewArrivals>
    <d2p1:PercentageOfYourFoodBill>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Percentage>0</d2p1:Percentage>
    </d2p1:PercentageOfYourFoodBill>
    <d2p1:PercentageOnAllMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:PercentageOnAllMerchandise>
    <d2p1:PercentageOnSelectedMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:PercentageOnSelectedMerchandise>
    <d2p1:PercentageRangeOnAllMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Start>0</d2p1:Start>
      <d2p1:Stop>0</d2p1:Stop>
    </d2p1:PercentageRangeOnAllMerchandise>
    <d2p1:SaveFoodAndMoney>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:SaveFoodAndMoney>
    <d2p1:SomeFreeTablesLeftToday>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:SomeFreeTablesLeftToday>
    <d2p1:TodaysBreakFastOffer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:TodaysBreakFastOffer>
    <d2p1:TodaysDinnerOffer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:TodaysDinnerOffer>
    <d2p1:TodaysLunchOffer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:TodaysLunchOffer>
    <d2p1:TotalAmountOverXgivesYdiscount>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:IfTotalAmountMoreThanX>0</d2p1:IfTotalAmountMoreThanX>
      <d2p1:ThenYouGetDiscountPercentageY>0</d2p1:ThenYouGetDiscountPercentageY>
    </d2p1:TotalAmountOverXgivesYdiscount>
    <d2p1:TwoDishesForThePriceOfOne>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:TwoDishesForThePriceOfOne>
    <d2p1:XforY>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:IfYouBuyX>0</d2p1:IfYouBuyX>
      <d2p1:ThenYouGetY>0</d2p1:ThenYouGetY>
    </d2p1:XforY>
  </DetailsUnion>
  <PlaceId>0</PlaceId>
</CreateAdRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateAdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <Id>0</Id>
</CreateAdResponse>