Needio.Services

<back to all web services

GetSmSettingsRequest

The following routes are available for this service:
All Verbs/Sm/GetSmCategorySettings
GetSmSettingsRequest Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
CodequerystringNo
PostTypesYnqueryboolNo
CatChainYnqueryboolNo
CatListYnqueryboolNo
AttListYnqueryboolNo
StoreSettingYnqueryboolNo
PostSettingYnqueryboolNo
PtSettingYnqueryboolNo
BrandYnqueryboolNo
VAttDefYnqueryboolNo
VAttDataYnqueryboolNo
MinLevelqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetSmSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
CategoryChainformSmCategoryMetaDTONo
CategoryListformList<SmCategoryMetaDTO>No
PostTypeformSmCategoryMetaDTONo
PostTypesformList<SmCategoryMetaDTO>No
AttributesListformList<SmAttributeDefDTO>No
BrandsformList<BrandDto>No
PostSettingformPostSettingsNo
StoreSettingformStoreSettingsNo
PtSettingformPtSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
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
PostSettings Parameters:
NameParameterData TypeRequiredDescription
UseMapInPostformUseTypesNo
UseStartEndDateformboolNo
UseBrandYnformUseTypesNo
MaxMediaCountformintNo
UseStockformUseTypesNo
UseConditionformUseTypesNo
UseSaleTypeformUseTypesNo
UsePostDescformUseTypesNo
UsePostSummaryformUseTypesNo
AddressLevelformAddressLevelsNo
LabelDescriptionformstringNo
LabelHeaderformstringNo
LabelAddToBasketformstringNo
LabelChatformstringNo
LabelPriceformstringNo
UseNoPriceformboolNo
UseSinglePriceformboolNo
UseVariantformboolNo
AllowCustomVariantformboolNo
TimeBasedVariantYnformboolNo
VariantAtt1DefformintNo
VariantAtt2DefformintNo
VariantAtt3DefformintNo
VariantAtt4DefformintNo
AllowSaleformboolNo
AllowReturnformboolNo
AllowSerialNumberformboolNo
MaxReturnDaysformintNo
AllowStopInSalerApproveformboolNo
AllowAddingToBasketformboolNo
ServiceRegionYnformboolNo
UseCatalogProductformUseTypesNo
MaxInstallmentNumberformintNo
MaxInstallmentNumber2formintNo
MaxInstallmentComNumberformintNo
MaxInstallmentLimitformdecimalNo
MaxInstallmentLimit2formdecimalNo
MaxInstallmentComLimitformdecimalNo
Plus18formboolNo
CategoryListStyleformintNo
UseTypes Enum:
NameValue
None0
Optional1
Required2
AddressLevels Enum:
NameValue
None0
State2
City3
District4
StoreSettings Parameters:
NameParameterData TypeRequiredDescription
UseMapInStoreformUseTypesNo
UseStoreDescformUseTypesNo
UseStoreSummaryformUseTypesNo
AllowActiveLocationformboolNo
AllowRouteMessageformboolNo
MaxMediaCountformintNo
UseDepartmentYnformboolNo
UseMinAmountForOrderformboolNo
AllowEmptyOrCustomBasketformboolNo
UseDeliveryMethodsformboolNo
AllowDeliveryToAddressformboolNo
AllowDeliveryInStoreformboolNo
AllowDeliveryByCargoformboolNo
ShippingPriceYnformboolNo
UseAmountPerDistanceformboolNo
UseAmountPerMinuteformboolNo
UseOpenHoursformboolNo
DefaultMinAmountForOrderformintNo
UseAverageServiceTimeformboolNo
DefaultAverageServiceTimeformintNo
UseMaxDeliveryDistanceformboolNo
DefaultMaxDistanceformintNo
PaymentWithNeedionformboolNo
PaymentOnAddresYnformboolNo
DefaultCommissionRateformdecimalNo
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
GetSmSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
CategoryChainformSmCategoryMetaDTONo
CategoryListformList<SmCategoryMetaDTO>No
PostTypeformSmCategoryMetaDTONo
PostTypesformList<SmCategoryMetaDTO>No
AttributesListformList<SmAttributeDefDTO>No
BrandsformList<BrandDto>No
PostSettingformPostSettingsNo
StoreSettingformStoreSettingsNo
PtSettingformPtSettingsNo

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

{
	Id: 0,
	Code: String,
	PostTypesYn: False,
	CatChainYn: False,
	CatListYn: False,
	AttListYn: False,
	StoreSettingYn: False,
	PostSettingYn: False,
	PtSettingYn: False,
	BrandYn: False,
	VAttDefYn: False,
	VAttDataYn: False,
	MinLevel: 0,
	start: 2021-12-08T04:06:19.4330392+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CategoryChain: 
	{
		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,
						SubCats: 
						[
							{
								
							}
						],
						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
	},
	CategoryList: 
	[
		{
			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
		}
	],
	PostType: 
	{
		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,
						SubCats: 
						[
							{
								
							}
						],
						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
	},
	PostTypes: 
	[
		{
			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
		}
	],
	AttributesList: 
	[
		{
			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
		}
	],
	PostSetting: 
	{
		UseMapInPost: 0,
		UseStartEndDate: False,
		UseBrandYn: 0,
		MaxMediaCount: 0,
		UseStock: 0,
		UseCondition: 0,
		UseSaleType: 0,
		UsePostDesc: 0,
		UsePostSummary: 0,
		AddressLevel: 0,
		LabelDescription: String,
		LabelHeader: String,
		LabelAddToBasket: String,
		LabelChat: String,
		LabelPrice: String,
		UseNoPrice: False,
		UseSinglePrice: False,
		UseVariant: False,
		AllowCustomVariant: False,
		TimeBasedVariantYn: False,
		VariantAtt1Def: 0,
		VariantAtt2Def: 0,
		VariantAtt3Def: 0,
		VariantAtt4Def: 0,
		AllowSale: False,
		AllowReturn: False,
		AllowSerialNumber: False,
		MaxReturnDays: 0,
		AllowStopInSalerApprove: False,
		AllowAddingToBasket: False,
		ServiceRegionYn: False,
		UseCatalogProduct: 0,
		MaxInstallmentNumber: 0,
		MaxInstallmentNumber2: 0,
		MaxInstallmentComNumber: 0,
		MaxInstallmentLimit: 0,
		MaxInstallmentLimit2: 0,
		MaxInstallmentComLimit: 0,
		Plus18: False,
		CategoryListStyle: 0
	},
	StoreSetting: 
	{
		UseMapInStore: 0,
		UseStoreDesc: 0,
		UseStoreSummary: 0,
		AllowActiveLocation: False,
		AllowRouteMessage: False,
		MaxMediaCount: 0,
		UseDepartmentYn: False,
		UseMinAmountForOrder: False,
		AllowEmptyOrCustomBasket: False,
		UseDeliveryMethods: False,
		AllowDeliveryToAddress: False,
		AllowDeliveryInStore: False,
		AllowDeliveryByCargo: False,
		ShippingPriceYn: False,
		UseAmountPerDistance: False,
		UseAmountPerMinute: False,
		UseOpenHours: False,
		DefaultMinAmountForOrder: 0,
		UseAverageServiceTime: False,
		DefaultAverageServiceTime: 0,
		UseMaxDeliveryDistance: False,
		DefaultMaxDistance: 0,
		PaymentWithNeedion: False,
		PaymentOnAddresYn: False,
		DefaultCommissionRate: 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
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}