Needio.Services

<back to all web services

GetSmCategoryDetailRequest

The following routes are available for this service:
All Verbs/Sm/GetSmCategoryDetail/
GetSmCategoryDetailRequest Parameters:
NameParameterData TypeRequiredDescription
CodequerystringNo
CategoryIdqueryintNo
CTypequerySmCategoryTypeNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetSmCategoryDetailResponse Parameters:
NameParameterData TypeRequiredDescription
CategoryformSmCategoryMetaDTONo
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
GetSmCategoryDetailResponse Parameters:
NameParameterData TypeRequiredDescription
CategoryformSmCategoryMetaDTONo

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

{
	Code: String,
	CategoryId: 0,
	CType: 0,
	start: 2021-10-19T18:16:35.2067110+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Category: 
	{
		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
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}