Needio.Services

<back to all web services

GetBannersRequest

The following routes are available for this service:
All Verbs/Genel/GetBanners
GetBannersRequest Parameters:
NameParameterData TypeRequiredDescription
BannerCodequerystringNo
CategoryKeyquerystringNo
IncludeParsedUrlqueryboolNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetBannersResponse Parameters:
NameParameterData TypeRequiredDescription
BannersformList<BannerDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
BannerDto Parameters:
NameParameterData TypeRequiredDescription
BannerIdformintNo
BannerCodeformstringNo
CategoryKeyformstringNo
SliderTypeformshortNo
HeaderTextformstringNo
ItemTypeformItemTypesNo
DisplayTypeformBannerDisplayTypesNo
ActiveYnformboolNo
OrderformintNo
ItemsformstringNo
ActionformDBActionNo
UrlTypeformUrlTypesNo
AllLinkTextformstringNo
AllLinkUrlformstringNo
ParamsformstringNo
BannerItemsformList<BannerItemDto>No
SliderItemsformList<SItemDto>No
ItemTypes Enum:
NameValue
Post1
Store2
Category3
Product4
Campaign11
Banner21
BannerDisplayTypes Enum:
NameValue
ItemOnly0
MainSlider1
PopulerBanner2
Item3Banner3
Item4Banner4
Item5Banner5
Item1Banner6
Item2Banner7
HeaderBanner8
CategoryBanner11
MenuBanner12
ItemSlider101
DBAction Enum:
NameValue
None0
Insert1
Update2
Delete3
UrlTypes Enum:
NameValue
Default0
Post1
Store2
Campaign3
CampaignList4
Category8
BannerItemDto Parameters:
NameParameterData TypeRequiredDescription
BannerItemIdformintNo
BannerIdformintNo
ThumbnailformstringNo
MediaWebformstringNo
MediaMobilformstringNo
HeaderTextformstringNo
InfoTextformstringNo
SlidingTextformstringNo
ActiveYnformboolNo
BeginDateformDateTimeNo
EndDateformDateTime?No
OrderformintNo
ItemDisplayTypeformBannerItemDisplayTypesNo
UrlTypeformUrlTypesNo
TargetIdformstringNo
FriendlyUrlformstringNo
ParsedUrlformUrlComponentsNo
ParamsformstringNo
BackgroundMediaformstringNo
BackgroundColorformstringNo
Content1200formstringNo
Content1000formstringNo
Content400formstringNo
ActionformDBActionNo
TimerYnformboolNo
BannerItemDisplayTypes Enum:
NameValue
Classic0
FullImage1
Content2
ImageOnLeft11
ImageOnRight12
ImageOnTop13
ImageOnBottom14
UrlComponents Parameters:
NameParameterData TypeRequiredDescription
DomainformstringNo
PageformstringNo
KeyformintNo
CatKeyformstringNo
CampaignCodeformstringNo
Segmentsformstring[]No
ParamsformDictionary<string, string>No
SearchAttrDatasformList<SearchAttrData>No
SearchAttrData Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
KeyformstringNo
SItemDto Parameters:
NameParameterData TypeRequiredDescription
ItemTypeformItemTypesNo
ItemIdformintNo
ItemKeyformstringNo
ItemNameformstringNo
ItemHeaderformstringNo
DescriptionformstringNo
CategoryKeyformstringNo
ConditionIdformintNo
ParentItemTypeformItemTypesNo
ParentItemIdformintNo
ParentItemHeaderformstringNo
ParentFriendlyURLformstringNo
ParentMainMediaIdformstringNo
ParentMainMediaFriendlyURLformstringNo
PostTypeIdformshortNo
LocationformGeoLocationNo
MainMediaIdformstringNo
MainMediaFriendlyURLformstringNo
ListPriceformdecimal?No
SalePriceformdecimal?No
DiscountRateformdecimal?No
AddCommisionYnformboolNo
PublishYnformboolNo
MapAvatarformstringNo
FriendlyURLformstringNo
AvgRateformdecimalNo
RateCountformintNo
FollowCountformintNo
ViewCountformintNo
DidUserFollowformboolNo
ScoreformshortNo
DistanceformdoubleNo
StockTypeformshort?No
PriceTypeformshort?No
InStockYnformbool?No
InStockformint?No
AllowSaleYnformboolNo
CampaingnformItemCampaignDtoNo
PropertiesformList<PropertyDto>No
CargoPriceformdecimalNo
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
ItemCampaignDto Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignCodeformstringNo
DescriptionformstringNo
MessageformstringNo
CampaignMessageformstringNo
ItemIdformintNo
ItemTypeformItemTypesNo
SaleQtyformintNo
MinimumQtyformintNo
InputSalePriceformdecimalNo
CSalePriceformdecimalNo
CTotalPriceformdecimalNo
CampaignTypeformCampaignTypesNo
CDiscountTypeformCampaignDiscountTypesNo
CDiscountQtyformintNo
CDiscountRateformdecimalNo
CDiscountAmtformdecimalNo
BeginDateformDateTimeNo
EndDateformDateTimeNo
LogoUrlformstringNo
ShowPriceYnformboolNo
CampaignAppliedformboolNo
CampaignTypes Enum:
NameValue
OnlyList0
SameProduct1
DifferentProduct2
AnyProduct3
Custom4
BasketDiscount11
StoreDiscount12
CampaignDiscountTypes Enum:
NameValue
Percent1
Amount2
Quantity3
PropertyDto Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
GetBannersResponse Parameters:
NameParameterData TypeRequiredDescription
BannersformList<BannerDto>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"BannerCode":"String","CategoryKey":"String","IncludeParsedUrl":false,"start":"\/Date(1638558553637+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Banners":[{"BannerId":0,"BannerCode":"String","CategoryKey":"String","SliderType":0,"HeaderText":"String","ItemType":1,"DisplayType":0,"ActiveYn":false,"Order":0,"Items":"String","Action":0,"UrlType":0,"AllLinkText":"String","AllLinkUrl":"String","Params":"String","BannerItems":[{"BannerItemId":0,"BannerId":0,"Thumbnail":"String","MediaWeb":"String","MediaMobil":"String","HeaderText":"String","InfoText":"String","SlidingText":"String","ActiveYn":false,"BeginDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","Order":0,"ItemDisplayType":0,"UrlType":0,"TargetId":"String","FriendlyUrl":"String","ParsedUrl":{"Domain":"String","Page":"String","Key":0,"CatKey":"String","CampaignCode":"String","Segments":["String"],"Params":{"String":"String"},"SearchAttrDatas":[{"Type":"String","Key":"String"}]},"Params":"String","BackgroundMedia":"String","BackgroundColor":"String","Content1200":"String","Content1000":"String","Content400":"String","Action":0,"TimerYn":false}],"SliderItems":[{"ItemType":1,"ItemId":0,"ItemKey":"String","ItemName":"String","ItemHeader":"String","Description":"String","CategoryKey":"String","ConditionId":0,"ParentItemType":1,"ParentItemId":0,"ParentItemHeader":"String","ParentFriendlyURL":"String","ParentMainMediaId":"String","ParentMainMediaFriendlyURL":"String","PostTypeId":0,"Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"MainMediaId":"String","MainMediaFriendlyURL":"String","ListPrice":0,"SalePrice":0,"DiscountRate":0,"AddCommisionYn":false,"PublishYn":false,"MapAvatar":"String","FriendlyURL":"String","AvgRate":0,"RateCount":0,"FollowCount":0,"ViewCount":0,"DidUserFollow":false,"Score":0,"Distance":0,"StockType":0,"PriceType":0,"InStockYn":false,"InStock":0,"AllowSaleYn":false,"Campaingn":{"CampaignId":0,"CampaignCode":"String","Description":"String","Message":"String","CampaignMessage":"String","ItemId":0,"ItemType":1,"SaleQty":0,"MinimumQty":0,"InputSalePrice":0,"CSalePrice":0,"CTotalPrice":0,"CampaignType":0,"CDiscountType":1,"CDiscountQty":0,"CDiscountRate":0,"CDiscountAmt":0,"BeginDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","LogoUrl":"String","ShowPriceYn":false,"CampaignApplied":false},"Properties":[{"Key":"String","Value":"String"}],"CargoPrice":0}]}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}