TBS Apps API

<back to all web services

UmbracoPromotionsRequest

The following routes are available for this service:
GET,POST/UmbracoPromotionsGets Promotions from the CMS.Gets Umbraco Promotions.
UmbracoPromotionsResponse Parameters:
NameParameterData TypeRequiredDescription
PromotionsformList<DtoUmbracoPromotion>No
DtoUmbracoPromotion Parameters:
NameParameterData TypeRequiredDescription
PromotionContentIdformintNo
PromotionIdformstringNo
NameformstringNo
DescriptionformstringNo
PromotionStartDateformDateTimeNo
PromotionEndDateformDateTimeNo
IconUrlformstringNo
ImageUrlformstringNo
TermsAndConditionStringformstringNo
LinkTitleformstringNo
LinkUrlformstringNo
IsPublicformboolNo

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 /UmbracoPromotions HTTP/1.1 
Host: ios-api.betright.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UmbracoPromotionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UmbracoPromotionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions">
  <Promotions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.CommonModels">
    <d2p1:DtoUmbracoPromotion>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IconUrl>String</d2p1:IconUrl>
      <d2p1:ImageUrl>String</d2p1:ImageUrl>
      <d2p1:IsPublic>false</d2p1:IsPublic>
      <d2p1:LinkTitle>String</d2p1:LinkTitle>
      <d2p1:LinkUrl>String</d2p1:LinkUrl>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PromotionContentId>0</d2p1:PromotionContentId>
      <d2p1:PromotionEndDate>0001-01-01T00:00:00</d2p1:PromotionEndDate>
      <d2p1:PromotionId>String</d2p1:PromotionId>
      <d2p1:PromotionStartDate>0001-01-01T00:00:00</d2p1:PromotionStartDate>
      <d2p1:TermsAndConditionString>String</d2p1:TermsAndConditionString>
    </d2p1:DtoUmbracoPromotion>
  </Promotions>
</UmbracoPromotionsResponse>