BusinessApi

<back to all web services

UpdateAdRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
PUT/ad/update
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BusinessApi

Namespace Global

    Namespace BusinessApi

        Public Partial Class AdDetailsAbsoluteDiscountOnSelectedMerchandise
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsAbsoluteDiscountRangeOnAllMerchandise
            Inherits AdDetailsBase
            Public Property Start As Double
            Public Property [Stop] As Double
        End Class

        Public Partial Class AdDetailsBase
            Public Property Description As String
            Public Property MoreInformation As List(Of String) = New List(Of String)
        End Class

        Public Partial Class AdDetailsFreetext
            Inherits AdDetailsBase
            Public Property Title As String
        End Class

        Public Partial Class AdDetailsHappyHour
            Inherits AdDetailsBase
        End Class

        Public Partial Class AdDetailsNewArrivals
            Inherits AdDetailsBase
        End Class

        Public Partial Class AdDetailsPercentageDiscountOnAllMerchandise
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsPercentageDiscountOnSelectedMerchandise
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsPercentageDiscountRangeOnAllMerchandise
            Inherits AdDetailsBase
            Public Property Start As Double
            Public Property [Stop] As Double
        End Class

        Public Partial Class AdDetailsPercentageOffYourFoodBill
            Inherits AdDetailsBase
            Public Property Percentage As Double
        End Class

        Public Partial Class AdDetailsSaveFoodAndMoney
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsSomeFreeTablesLeftToday
            Inherits AdDetailsBase
        End Class

        Public Partial Class AdDetailsTodaysBreakFastOffer
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsTodaysDinnerOffer
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsTodaysLunchOffer
            Inherits AdDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdDetailsTotalAmountOverXgivesYdiscount
            Inherits AdDetailsBase
            Public Property IfTotalAmountMoreThanX As Double
            Public Property ThenYouGetDiscountPercentageY As Double
        End Class

        Public Partial Class AdDetailsTwoDishesForThePriceOfOne
            Inherits AdDetailsBase
        End Class

        Public Partial Class AdDetailsUnion
            Public Property PercentageOnAllMerchandise As AdDetailsPercentageDiscountOnAllMerchandise
            Public Property PercentageRangeOnAllMerchandise As AdDetailsPercentageDiscountRangeOnAllMerchandise
            Public Property PercentageOnSelectedMerchandise As AdDetailsPercentageDiscountOnSelectedMerchandise
            Public Property AbsoluteOnSelectedMerchandise As AdDetailsAbsoluteDiscountOnSelectedMerchandise
            Public Property AbsoluteRangeOnAllMerchandise As AdDetailsAbsoluteDiscountRangeOnAllMerchandise
            Public Property TotalAmountOverXgivesYdiscount As AdDetailsTotalAmountOverXgivesYdiscount
            Public Property XforY As AdDetailsXforYdiscount
            Public Property NewArrivals As AdDetailsNewArrivals
            Public Property Freetext As AdDetailsFreetext
            Public Property TodaysBreakFastOffer As AdDetailsTodaysBreakFastOffer
            Public Property TodaysLunchOffer As AdDetailsTodaysLunchOffer
            Public Property TodaysDinnerOffer As AdDetailsTodaysDinnerOffer
            Public Property SaveFoodAndMoney As AdDetailsSaveFoodAndMoney
            Public Property PercentageOfYourFoodBill As AdDetailsPercentageOffYourFoodBill
            Public Property HappyHour As AdDetailsHappyHour
            Public Property SomeFreeTablesLeftToday As AdDetailsSomeFreeTablesLeftToday
            Public Property TwoDishesForThePriceOfOne As AdDetailsTwoDishesForThePriceOfOne
        End Class

        Public Partial Class AdDetailsXforYdiscount
            Inherits AdDetailsBase
            Public Property IfYouBuyX As Integer
            Public Property ThenYouGetY As Integer
        End Class
    End Namespace
End Namespace

VB.NET UpdateAdRequest 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.

PUT /ad/update HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdId>0</AdId>
  <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>
  <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>
  <StopAt>
    <Day>0</Day>
    <Hour>0</Hour>
    <Minute>0</Minute>
    <Month>0</Month>
    <Second>0</Second>
    <Year>0</Year>
  </StopAt>
</UpdateAdRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateAdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdId>0</AdId>
</UpdateAdResponse>