Needio.Services

GetBannersRequest

The following routes are available for this service:
All Verbs	/Genel/GetBanners

**GetBannersRequest** Parameters:
Name	Parameter	Data Type	Required
BannerCode	query	string	No
CategoryKey	query	string	No
IncludeParsedUrl	query	bool	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
start	form	DateTime	No
DeviceUUID	form	string	No
APIKey	form	string	No
isAdmin	form	bool	No
Cmd	form	string	No

**GetBannersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Banners	form	List<BannerDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Result	form	bool	No
ResMessage	form	string	No
Error	form	Error	No
PageInfo	form	BasePageInfo	No

**Error** Parameters:
Name	Parameter	Data Type	Required
ErrorYn	form	bool	No
ExYn	form	bool	No
ErrorCode	form	string	No
ErrorDescription	form	string	No

**BasePageInfo** Parameters:
Name	Parameter	Data Type	Required
TotalRecordCount	form	int	No
TotalPageCount	form	int	No
CurrentPage	form	int	No

**BannerDto** Parameters:
Name	Parameter	Data Type	Required
BannerId	form	int	No
BannerCode	form	string	No
CategoryKey	form	string	No
SliderType	form	short	No
HeaderText	form	string	No
ItemType	form	ItemTypes	No
DisplayType	form	BannerDisplayTypes	No
ActiveYn	form	bool	No
Order	form	int	No
Items	form	string	No
Action	form	DBAction	No
UrlType	form	UrlTypes	No
AllLinkText	form	string	No
AllLinkUrl	form	string	No
Params	form	string	No
BannerItems	form	List<BannerItemDto>	No
SliderItems	form	List<SItemDto>	No

**ItemTypes** Enum:
Name	Value
Post	1
Store	2
Category	3
Product	4
Campaign	5
Banner	21

**BannerDisplayTypes** Enum:
Name	Value
ItemOnly	0
MainSlider	1
PopulerBanner	2
Item3Banner	3
Item4Banner	4
Item5Banner	5
Item1Banner	6
Item2Banner	7
HeaderBanner	8
CategoryBanner	11
MenuBanner	12
ItemSlider	101

**DBAction** Enum:
Name	Value
None	0
Insert	1
Update	2
Delete	3

**UrlTypes** Enum:
Name	Value
Default	0
Post	1
Store	2
Campaign	3
CampaignList	4
Category	8

**BannerItemDto** Parameters:
Name	Parameter	Data Type	Required
BannerItemId	form	int	No
BannerId	form	int	No
Thumbnail	form	string	No
MediaWeb	form	string	No
MediaMobil	form	string	No
HeaderText	form	string	No
InfoText	form	string	No
SlidingText	form	string	No
ActiveYn	form	bool	No
BeginDate	form	DateTime	No
EndDate	form	DateTime?	No
Order	form	int	No
ItemDisplayType	form	BannerItemDisplayTypes	No
UrlType	form	UrlTypes	No
TargetId	form	string	No
FriendlyUrl	form	string	No
ParsedUrl	form	UrlComponents	No
Params	form	string	No
BackgroundMedia	form	string	No
BackgroundColor	form	string	No
Content1200	form	string	No
Content1000	form	string	No
Content400	form	string	No
Action	form	DBAction	No
TimerYn	form	bool	No

**BannerItemDisplayTypes** Enum:
Name	Value
Classic	0
FullImage	1
Content	2
ImageOnLeft	11
ImageOnRight	12
ImageOnTop	13
ImageOnBottom	14

**UrlComponents** Parameters:
Name	Parameter	Data Type	Required
Domain	form	string	No
Page	form	string	No
Key	form	int	No
CatKey	form	string	No
CampaignCode	form	string	No
Segments	form	string[]	No
Params	form	Dictionary<string, string>	No
SearchAttrDatas	form	List<SearchAttrData>	No

**SearchAttrData** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
Key	form	string	No

**SItemDto** Parameters:
Name	Parameter	Data Type	Required
ItemType	form	ItemTypes	No
ItemId	form	int	No
ItemKey	form	string	No
ItemName	form	string	No
ItemHeader	form	string	No
Description	form	string	No
CategoryKey	form	string	No
ConditionId	form	int	No
ParentItemType	form	ItemTypes	No
ParentItemId	form	int	No
ParentItemHeader	form	string	No
ParentFriendlyURL	form	string	No
ParentMainMediaId	form	string	No
ParentMainMediaFriendlyURL	form	string	No
PostTypeId	form	short	No
Location	form	GeoLocation	No
MainMediaId	form	string	No
MainMediaFriendlyURL	form	string	No
ListPrice	form	decimal?	No
SalePrice	form	decimal?	No
MinSalePrice	form	decimal?	No
DiscountRate	form	decimal?	No
AddCommisionYn	form	bool	No
PublishYn	form	bool	No
MapAvatar	form	string	No
FriendlyURL	form	string	No
AvgRate	form	decimal	No
RateCount	form	int	No
FollowCount	form	int	No
ViewCount	form	int	No
DidUserFollow	form	bool	No
Score	form	short	No
Distance	form	double	No
StockType	form	short?	No
PriceType	form	short?	No
InStockYn	form	bool?	No
InStock	form	int?	No
AllowSaleYn	form	bool	No
Campaingn	form	ItemCampaignDto	No
Properties	form	List<PropertyDto>	No
CargoPrice	form	decimal	No
VariantColorCount	form	int	No
ListPrice2	form	decimal?	No
Summary	form	string	No
PostAge	form	int	No

**GeoLocation** Parameters:
Name	Parameter	Data Type	Required
Lon	form	string	No
Lat	form	string	No
GeoAddress	form	string	No
IsDeleted	form	bool	No

**ItemCampaignDto** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	int	No
CampaignCode	form	string	No
Description	form	string	No
Message	form	string	No
CampaignMessage	form	string	No
ItemId	form	int	No
ItemType	form	ItemTypes	No
SaleQty	form	int	No
MinimumQty	form	int	No
InputSalePrice	form	decimal	No
CSalePrice	form	decimal	No
CTotalPrice	form	decimal	No
CampaignType	form	CampaignTypes	No
CDiscountType	form	CampaignDiscountTypes	No
CDiscountQty	form	int	No
CDiscountRate	form	decimal	No
CDiscountAmt	form	decimal	No
BeginDate	form	DateTime	No
EndDate	form	DateTime	No
LogoUrl	form	string	No
ShowPriceYn	form	bool	No
CampaignApplied	form	bool	No
NeedionRate	form	decimal	No

**CampaignTypes** Enum:
Name	Value
OnlyList	0
SameProduct	1
DifferentProduct	2
AnyProduct	3
Custom	4
BasketDiscount	11
StoreDiscount	12

**CampaignDiscountTypes** Enum:
Name	Value
Percent	1
Amount	2
Quantity	3

**PropertyDto** Parameters:
Name	Parameter	Data Type	Required	Description
Key	form	string	No
Value	form	string	No

**GetBannersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Banners	form	List<BannerDto>	No

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 /Genel/GetBanners HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetBannersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <BannerCode>String</BannerCode>
  <CategoryKey>String</CategoryKey>
  <IncludeParsedUrl>false</IncludeParsedUrl>
</GetBannersRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetBannersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Banners xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:BannerDto>
      <d2p1:Action>None</d2p1:Action>
      <d2p1:ActiveYn>false</d2p1:ActiveYn>
      <d2p1:AllLinkText>String</d2p1:AllLinkText>
      <d2p1:AllLinkUrl>String</d2p1:AllLinkUrl>
      <d2p1:BannerCode>String</d2p1:BannerCode>
      <d2p1:BannerId>0</d2p1:BannerId>
      <d2p1:BannerItems>
        <d2p1:BannerItemDto>
          <d2p1:Action>None</d2p1:Action>
          <d2p1:ActiveYn>false</d2p1:ActiveYn>
          <d2p1:BackgroundColor>String</d2p1:BackgroundColor>
          <d2p1:BackgroundMedia>String</d2p1:BackgroundMedia>
          <d2p1:BannerId>0</d2p1:BannerId>
          <d2p1:BannerItemId>0</d2p1:BannerItemId>
          <d2p1:BeginDate>0001-01-01T00:00:00</d2p1:BeginDate>
          <d2p1:Content1000>String</d2p1:Content1000>
          <d2p1:Content1200>String</d2p1:Content1200>
          <d2p1:Content400>String</d2p1:Content400>
          <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
          <d2p1:FriendlyUrl>String</d2p1:FriendlyUrl>
          <d2p1:HeaderText>String</d2p1:HeaderText>
          <d2p1:InfoText>String</d2p1:InfoText>
          <d2p1:ItemDisplayType>Classic</d2p1:ItemDisplayType>
          <d2p1:MediaMobil>String</d2p1:MediaMobil>
          <d2p1:MediaWeb>String</d2p1:MediaWeb>
          <d2p1:Order>0</d2p1:Order>
          <d2p1:Params>String</d2p1:Params>
          <d2p1:ParsedUrl>
            <d2p1:CampaignCode>String</d2p1:CampaignCode>
            <d2p1:CatKey>String</d2p1:CatKey>
            <d2p1:Domain>String</d2p1:Domain>
            <d2p1:Key>0</d2p1:Key>
            <d2p1:Page>String</d2p1:Page>
            <d2p1:Params xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d2p1:Params>
            <d2p1:SearchAttrDatas>
              <SearchAttrData>
                <Key>String</Key>
                <Type>String</Type>
              </SearchAttrData>
            </d2p1:SearchAttrDatas>
            <d2p1:Segments xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:Segments>
          </d2p1:ParsedUrl>
          <d2p1:SlidingText>String</d2p1:SlidingText>
          <d2p1:TargetId>String</d2p1:TargetId>
          <d2p1:Thumbnail>String</d2p1:Thumbnail>
          <d2p1:TimerYn>false</d2p1:TimerYn>
          <d2p1:UrlType>Default</d2p1:UrlType>
        </d2p1:BannerItemDto>
      </d2p1:BannerItems>
      <d2p1:CategoryKey>String</d2p1:CategoryKey>
      <d2p1:DisplayType>ItemOnly</d2p1:DisplayType>
      <d2p1:HeaderText>String</d2p1:HeaderText>
      <d2p1:ItemType>Post</d2p1:ItemType>
      <d2p1:Items>String</d2p1:Items>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:Params>String</d2p1:Params>
      <d2p1:SliderItems>
        <d2p1:SItemDto>
          <d2p1:AddCommisionYn>false</d2p1:AddCommisionYn>
          <d2p1:AllowSaleYn>false</d2p1:AllowSaleYn>
          <d2p1:AvgRate>0</d2p1:AvgRate>
          <d2p1:Campaingn>
            <d2p1:BeginDate>0001-01-01T00:00:00</d2p1:BeginDate>
            <d2p1:CDiscountAmt>0</d2p1:CDiscountAmt>
            <d2p1:CDiscountQty>0</d2p1:CDiscountQty>
            <d2p1:CDiscountRate>0</d2p1:CDiscountRate>
            <d2p1:CDiscountType>Percent</d2p1:CDiscountType>
            <d2p1:CSalePrice>0</d2p1:CSalePrice>
            <d2p1:CTotalPrice>0</d2p1:CTotalPrice>
            <d2p1:CampaignApplied>false</d2p1:CampaignApplied>
            <d2p1:CampaignCode>String</d2p1:CampaignCode>
            <d2p1:CampaignId>0</d2p1:CampaignId>
            <d2p1:CampaignMessage>String</d2p1:CampaignMessage>
            <d2p1:CampaignType>OnlyList</d2p1:CampaignType>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
            <d2p1:InputSalePrice>0</d2p1:InputSalePrice>
            <d2p1:ItemId>0</d2p1:ItemId>
            <d2p1:ItemType>Post</d2p1:ItemType>
            <d2p1:LogoUrl>String</d2p1:LogoUrl>
            <d2p1:Message>String</d2p1:Message>
            <d2p1:MinimumQty>0</d2p1:MinimumQty>
            <d2p1:NeedionRate>0</d2p1:NeedionRate>
            <d2p1:SaleQty>0</d2p1:SaleQty>
            <d2p1:ShowPriceYn>false</d2p1:ShowPriceYn>
          </d2p1:Campaingn>
          <d2p1:CargoPrice>0</d2p1:CargoPrice>
          <d2p1:CategoryKey>String</d2p1:CategoryKey>
          <d2p1:ConditionId>0</d2p1:ConditionId>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:DidUserFollow>false</d2p1:DidUserFollow>
          <d2p1:DiscountRate>0</d2p1:DiscountRate>
          <d2p1:Distance>0</d2p1:Distance>
          <d2p1:FollowCount>0</d2p1:FollowCount>
          <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
          <d2p1:InStock>0</d2p1:InStock>
          <d2p1:InStockYn>false</d2p1:InStockYn>
          <d2p1:ItemHeader>String</d2p1:ItemHeader>
          <d2p1:ItemId>0</d2p1:ItemId>
          <d2p1:ItemKey>String</d2p1:ItemKey>
          <d2p1:ItemName>String</d2p1:ItemName>
          <d2p1:ItemType>Post</d2p1:ItemType>
          <d2p1:ListPrice>0</d2p1:ListPrice>
          <d2p1:ListPrice2>0</d2p1:ListPrice2>
          <d2p1:Location>
            <d2p1:GeoAddress>String</d2p1:GeoAddress>
            <d2p1:IsDeleted>false</d2p1:IsDeleted>
            <d2p1:Lat>String</d2p1:Lat>
            <d2p1:Lon>String</d2p1:Lon>
          </d2p1:Location>
          <d2p1:MainMediaFriendlyURL>String</d2p1:MainMediaFriendlyURL>
          <d2p1:MainMediaId>String</d2p1:MainMediaId>
          <d2p1:MapAvatar>String</d2p1:MapAvatar>
          <d2p1:MinSalePrice>0</d2p1:MinSalePrice>
          <d2p1:ParentFriendlyURL>String</d2p1:ParentFriendlyURL>
          <d2p1:ParentItemHeader>String</d2p1:ParentItemHeader>
          <d2p1:ParentItemId>0</d2p1:ParentItemId>
          <d2p1:ParentItemType>Post</d2p1:ParentItemType>
          <d2p1:ParentMainMediaFriendlyURL>String</d2p1:ParentMainMediaFriendlyURL>
          <d2p1:ParentMainMediaId>String</d2p1:ParentMainMediaId>
          <d2p1:PostAge>0</d2p1:PostAge>
          <d2p1:PostTypeId>0</d2p1:PostTypeId>
          <d2p1:PriceType>0</d2p1:PriceType>
          <d2p1:Properties>
            <d2p1:PropertyDto>
              <d2p1:Key>String</d2p1:Key>
              <d2p1:Value>String</d2p1:Value>
            </d2p1:PropertyDto>
          </d2p1:Properties>
          <d2p1:PublishYn>false</d2p1:PublishYn>
          <d2p1:RateCount>0</d2p1:RateCount>
          <d2p1:SalePrice>0</d2p1:SalePrice>
          <d2p1:Score>0</d2p1:Score>
          <d2p1:StockType>0</d2p1:StockType>
          <d2p1:Summary>String</d2p1:Summary>
          <d2p1:VariantColorCount>0</d2p1:VariantColorCount>
          <d2p1:ViewCount>0</d2p1:ViewCount>
        </d2p1:SItemDto>
      </d2p1:SliderItems>
      <d2p1:SliderType>0</d2p1:SliderType>
      <d2p1:UrlType>Default</d2p1:UrlType>
    </d2p1:BannerDto>
  </Banners>
</GetBannersResponse>