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
DeviceUUIDformstringNo
APIKeyformstringNo
GetSmSearchSettingResponse Parameters:
NameParameterData TypeRequiredDescription
SettingsformSearchSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SearchSettings Parameters:
NameParameterData TypeRequiredDescription
BreadCrumbformList<SmCategoryMetaDTO>No
AttibuteDefsformList<SmAttributeDefDTO>No
VariantDefsformList<SmAttributeDefDTO>No
BrandsformList<BrandDto>No
PtSettingformPtSettingsNo
SuggestAttributeDefIdListformstringNo
SuggestTargetCatKeyformstringNo
SmCategoryMetaDTO Parameters:
NameParameterData TypeRequiredDescription
CTypeformSmCategoryTypeNo
SearchYnformboolNo
OrderformintNo
NTypeformSmCategoryTypeNo
FriendlyURLformstringNo
SelectedformboolNo
SubCatsformList<SmCategoryMetaDTO>No
LevelformbyteNo
DeepestYnformbool?No
CountformintNo
SearchWeightformdecimal?No
SmCategoryInfoDTO Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformintNo
NameformstringNo
CodeformstringNo
PIdformshort?No
ActiveYnformboolNo
TagsformstringNo
TitleformstringNo
KeywordsformstringNo
MetadataformstringNo
CategoryLabelformstringNo
SmCategoryType Enum:
NameValue
None0
PostType1
StoreCategory2
PostCategory3
Department11
Brand21
Model23
SmAttributeDefDTO Parameters:
NameParameterData TypeRequiredDescription
ATypeformSmAttributeTypesNo
STypeformSmAttributeSearchTypesNo
AnyTextformstringNo
AllTextformstringNo
CodeformstringNo
ITypeformSmInputTypesNo
AttributeDatasformList<SmAttributeDataDTO>No
DefaultValueformstringNo
MinValueformint?No
MaxValueformint?No
ParentAttributeDefIdformshort?No
HeaderTextformstringNo
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
OrderformintNo
BrandDto Parameters:
NameParameterData TypeRequiredDescription
BrandIdformintNo
BrandKeyformstringNo
BrandNameformstringNo
CountformintNo
PtSettings Parameters:
NameParameterData TypeRequiredDescription
SearchMapOnlyUsedConditionformboolNo
SearchMapDefaultScaleformintNo
SearchPostYnformboolNo
SearchStoreYnformboolNo
SearchPostOnMapYnformboolNo
SearchStoreOnMapYnformboolNo
SearchConditionYnformboolNo
SearchSaleTypeYnformboolNo
SearchDeliveryTypeYnformboolNo
SearchOpportunityProductsYnformboolNo
PtAllowSaleYnformboolNo
SearchDefaultformItemTypesNo
SearchMapMethodformItemTypesNo
DefaultCommissionRateformdecimalNo
VirtualDepartmentSourceformstringNo
FriendlyUrlSourceformstringNo
SearchAddressLevelformAddressLevelsNo
PostTypeDTO Parameters:
NameParameterData TypeRequiredDescription
PostTypeIdformintNo
NameformstringNo
DesciptionformstringNo
FriendlyUrlformstringNo
ActiveYnformboolNo
ItemTypes Enum:
NameValue
Post1
Store2
Category3
Product4
Campaign11
Banner21
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Code: String,
	start: 2021-11-28T14:32:05.0517336+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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,
								Level: 0,
								DeepestYn: False,
								Count: 0,
								SearchWeight: 0,
								CategoryId: 0,
								Name: String,
								Code: String,
								PId: 0,
								ActiveYn: False,
								Tags: String,
								Title: String,
								Keywords: String,
								Metadata: String,
								CategoryLabel: String
							}
						],
						Level: 0,
						DeepestYn: False,
						Count: 0,
						SearchWeight: 0,
						CategoryId: 0,
						Name: String,
						Code: String,
						PId: 0,
						ActiveYn: False,
						Tags: String,
						Title: String,
						Keywords: String,
						Metadata: String,
						CategoryLabel: String
					}
				],
				Level: 0,
				DeepestYn: False,
				Count: 0,
				SearchWeight: 0,
				CategoryId: 0,
				Name: String,
				Code: String,
				PId: 0,
				ActiveYn: False,
				Tags: String,
				Title: String,
				Keywords: String,
				Metadata: String,
				CategoryLabel: String
			}
		],
		AttibuteDefs: 
		[
			{
				AType: 1,
				SType: 0,
				AnyText: String,
				AllText: String,
				Code: String,
				IType: 1,
				AttributeDatas: 
				[
					{
						Key: String,
						Value: String,
						Count: 0,
						Order: 0
					}
				],
				DefaultValue: String,
				MinValue: 0,
				MaxValue: 0,
				ParentAttributeDefId: 0,
				HeaderText: String,
				AttributeDefId: 0,
				Name: String,
				LabelText: String,
				Required: False
			}
		],
		VariantDefs: 
		[
			{
				AType: 1,
				SType: 0,
				AnyText: String,
				AllText: String,
				Code: String,
				IType: 1,
				AttributeDatas: 
				[
					{
						Key: String,
						Value: String,
						Count: 0,
						Order: 0
					}
				],
				DefaultValue: String,
				MinValue: 0,
				MaxValue: 0,
				ParentAttributeDefId: 0,
				HeaderText: String,
				AttributeDefId: 0,
				Name: String,
				LabelText: String,
				Required: False
			}
		],
		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,
			SearchDeliveryTypeYn: False,
			SearchOpportunityProductsYn: 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
		},
		SuggestAttributeDefIdList: String,
		SuggestTargetCatKey: String
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}