Needio.Services

<back to all web services

GetSmSearchSettingRequest

The following routes are available for this service:
All Verbs/Sm/GetSearchSetting
GetSmSearchSettingRequest Parameters:
NameParameterData TypeRequiredDescription
CodequerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetSmSearchSettingResponse Parameters:
NameParameterData TypeRequiredDescription
SettingsformSearchSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
SearchSettings Parameters:
NameParameterData TypeRequiredDescription
BreadCrumbformList<SmCategoryMetaDTO>No
AttibuteDefsformList<SmAttributeDefDTO>No
VariantDefsformList<SmAttributeDefDTO>No
BrandsformList<BrandDto>No
PtSettingformPtSettingsNo
SmCategoryMetaDTO Parameters:
NameParameterData TypeRequiredDescription
CTypeformSmCategoryTypeNo
SearchYnformboolNo
OrderformintNo
NTypeformSmCategoryTypeNo
FriendlyURLformstringNo
SelectedformboolNo
SubCatsformList<SmCategoryMetaDTO>No
CountformintNo
SmCategoryInfoDTO Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformintNo
NameformstringNo
CodeformstringNo
PIdformshort?No
ActiveYnformboolNo
SmCategoryType Enum:
NameValue
None0
PostType1
StoreCategory2
PostCategory3
Department11
Brand21
Model23
SmAttributeDefDTO Parameters:
NameParameterData TypeRequiredDescription
ATypeformSmAttributeTypesNo
STypeformSmAttributeSearchTypesNo
AnyTextformstringNo
AllTextformstringNo
CodeformstringNo
RequiredformboolNo
ITypeformSmInputTypesNo
AttributeDatasformList<SmAttributeDataDTO>No
DefaultValueformstringNo
MinValueformintNo
MaxValueformintNo
SmAttributeInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AttributeDefIdformshortNo
NameformstringNo
LabelTextformstringNo
RequiredformboolNo
SmAttributeTypes Enum:
NameValue
Text1
Number2
Combo11
MultiSelect12
State13
Brand21
SmAttributeSearchTypes Enum:
NameValue
None0
NumberBetween2
SingleSelect11
MultiSelect12
SmInputTypes Enum:
NameValue
Text1
Number2
Tel3
SmAttributeDataDTO Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
CountformintNo
BrandDto Parameters:
NameParameterData TypeRequiredDescription
BrandIdformintNo
BrandKeyformstringNo
BrandNameformstringNo
CountformintNo
PtSettings Parameters:
NameParameterData TypeRequiredDescription
SearchMapOnlyUsedConditionformboolNo
SearchMapDefaultScaleformintNo
SearchPostYnformboolNo
SearchStoreYnformboolNo
SearchPostOnMapYnformboolNo
SearchStoreOnMapYnformboolNo
SearchConditionYnformboolNo
SearchSaleTypeYnformboolNo
PtAllowSaleYnformboolNo
SearchDefaultformItemTypesNo
SearchMapMethodformItemTypesNo
DefaultCommissionRateformdecimalNo
VirtualDepartmentSourceformstringNo
FriendlyUrlSourceformstringNo
SearchAddressLevelformAddressLevelsNo
PostTypeDTO Parameters:
NameParameterData TypeRequiredDescription
PostTypeIdformintNo
NameformstringNo
DesciptionformstringNo
FriendlyUrlformstringNo
ActiveYnformboolNo
ItemTypes Enum:
NameValue
Post1
Store2
User4
AdLocal8
AdGlobal16
SocialShare512
SocialStory1024
AddressLevels Enum:
NameValue
None0
State2
City3
District4
GetSmSearchSettingResponse Parameters:
NameParameterData TypeRequiredDescription
SettingsformSearchSettingsNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Sm/GetSearchSetting HTTP/1.1 
Host: baseservices2.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Code":"String","start":"\/Date(1594605185572+0300)\/"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Settings":{"BreadCrumb":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"SubCats":[{"CType":0,"SearchYn":false,"Order":0,"NType":0,"FriendlyURL":"String","Selected":false,"Count":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false}],"Count":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false}],"Count":0,"CategoryId":0,"Name":"String","Code":"String","PId":0,"ActiveYn":false}],"AttibuteDefs":[{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","Required":false,"IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"AttributeDefId":0,"Name":"String","LabelText":"String"}],"VariantDefs":[{"AType":1,"SType":0,"AnyText":"String","AllText":"String","Code":"String","Required":false,"IType":1,"AttributeDatas":[{"Key":"String","Value":"String","Count":0}],"DefaultValue":"String","MinValue":0,"MaxValue":0,"AttributeDefId":0,"Name":"String","LabelText":"String"}],"Brands":[{"BrandId":0,"BrandKey":"String","BrandName":"String","Count":0}],"PtSetting":{"SearchMapOnlyUsedCondition":false,"SearchMapDefaultScale":0,"SearchPostYn":false,"SearchStoreYn":false,"SearchPostOnMapYn":false,"SearchStoreOnMapYn":false,"SearchConditionYn":false,"SearchSaleTypeYn":false,"PtAllowSaleYn":false,"SearchDefault":1,"SearchMapMethod":1,"DefaultCommissionRate":0,"VirtualDepartmentSource":"String","FriendlyUrlSource":"String","SearchAddressLevel":0,"PostTypeId":0,"Name":"String","Desciption":"String","FriendlyUrl":"String","ActiveYn":false}},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"}}