Needio.Services.ExtApiHost

ExtGetSmCategoryDetailRequest

The following routes are available for this service:
All Verbs	/Ext/GetSmCategoryDetail

**ExtGetSmCategoryDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	int	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
start	form	DateTime	No
DeviceUUID	form	string	No
APIKey	form	string	No
isAdmin	form	bool	No
Cmd	form	string	No

**ExtGetSmCategoryDetailResponse** Parameters:
Name	Parameter	Data Type	Required
CategoryDetail	form	SmCategoryInfoDTO	No
AttributesList	form	List<SmAttributeInfoDTO>	No
AllowedVariantDefs	form	List<SmAttributeInfoDTO>	No
Brands	form	List<BrandDto>	No
PostSetting	form	ExtPostSettings	No
VAtt1DefId	form	int	No
VAtt2DefId	form	int	No
VAtt3DefId	form	int	No
VAtt4DefId	form	int	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Result	form	bool	No
ResMessage	form	string	No
Error	form	Error	No
PageInfo	form	BasePageInfo	No

**Error** Parameters:
Name	Parameter	Data Type	Required
ErrorYn	form	bool	No
ExYn	form	bool	No
ErrorCode	form	string	No
ErrorDescription	form	string	No

**BasePageInfo** Parameters:
Name	Parameter	Data Type	Required
TotalRecordCount	form	int	No
TotalPageCount	form	int	No
CurrentPage	form	int	No

**SmCategoryInfoDTO** Parameters:
Name	Parameter	Data Type	Required
CategoryId	form	int	No
Name	form	string	No
Code	form	string	No
PId	form	short?	No
ActiveYn	form	bool	No
Tags	form	string	No
Title	form	string	No
Keywords	form	string	No
Metadata	form	string	No
CategoryLabel	form	string	No

**SmAttributeInfoDTO** Parameters:
Name	Parameter	Data Type	Required
AttributeDefId	form	short	No
Name	form	string	No
LabelText	form	string	No
Required	form	bool	No
AType	form	SmAttributeTypes	No
DefaultKey	form	string	No
DefaultValue	form	string	No
MinValue	form	int?	No
MaxValue	form	int?	No

**SmAttributeTypes** Enum:
Name	Value
Text	1
Number	2
Combo	11
MultiSelect	12
State	13
Brand	21

**BrandDto** Parameters:
Name	Parameter	Data Type	Required
BrandId	form	int	No
BrandKey	form	string	No
BrandName	form	string	No
Count	form	int	No

**ExtPostSettings** Parameters:
Name	Parameter	Data Type	Required
UseMapInPost	form	UseTypes	No
UseStartEndDate	form	bool	No
UseBrandYn	form	UseTypes	No
MaxMediaCount	form	int	No
UseStock	form	UseTypes	No
UseCondition	form	UseTypes	No
UseSaleType	form	UseTypes	No
UsePostDesc	form	UseTypes	No
UsePostSummary	form	UseTypes	No
AddressLevel	form	AddressLevels	No
UseNoPrice	form	bool	No
UseSinglePrice	form	bool	No
UseVariant	form	bool	No
TimeBasedVariantYn	form	bool	No
VariantAtt1Def	form	int	No
VariantAtt2Def	form	int	No
VariantAtt3Def	form	int	No
VariantAtt4Def	form	int	No
UseCatalogProduct	form	UseTypes	No

**UseTypes** Enum:
None
Optional
Required

**AddressLevels** Enum:
Name	Value
None	0
State	2
City	3
District	4

**ExtGetSmCategoryDetailResponse** Parameters:
Name	Parameter	Data Type	Required
CategoryDetail	form	SmCategoryInfoDTO	No
AttributesList	form	List<SmAttributeInfoDTO>	No
AllowedVariantDefs	form	List<SmAttributeInfoDTO>	No
Brands	form	List<BrandDto>	No
PostSetting	form	ExtPostSettings	No
VAtt1DefId	form	int	No
VAtt2DefId	form	int	No
VAtt3DefId	form	int	No
VAtt4DefId	form	int	No

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

HTTP + XML

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

POST /Ext/GetSmCategoryDetail HTTP/1.1 
Host: apiservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExtGetSmCategoryDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <Id>0</Id>
</ExtGetSmCategoryDetailRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExtGetSmCategoryDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <AllowedVariantDefs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:SmAttributeInfoDTO>
      <d2p1:AType>Text</d2p1:AType>
      <d2p1:AttributeDefId>0</d2p1:AttributeDefId>
      <d2p1:DefaultKey>String</d2p1:DefaultKey>
      <d2p1:DefaultValue>String</d2p1:DefaultValue>
      <d2p1:LabelText>String</d2p1:LabelText>
      <d2p1:MaxValue>0</d2p1:MaxValue>
      <d2p1:MinValue>0</d2p1:MinValue>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Required>false</d2p1:Required>
    </d2p1:SmAttributeInfoDTO>
  </AllowedVariantDefs>
  <AttributesList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:SmAttributeInfoDTO>
      <d2p1:AType>Text</d2p1:AType>
      <d2p1:AttributeDefId>0</d2p1:AttributeDefId>
      <d2p1:DefaultKey>String</d2p1:DefaultKey>
      <d2p1:DefaultValue>String</d2p1:DefaultValue>
      <d2p1:LabelText>String</d2p1:LabelText>
      <d2p1:MaxValue>0</d2p1:MaxValue>
      <d2p1:MinValue>0</d2p1:MinValue>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Required>false</d2p1:Required>
    </d2p1:SmAttributeInfoDTO>
  </AttributesList>
  <Brands xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:BrandDto>
      <d2p1:BrandId>0</d2p1:BrandId>
      <d2p1:BrandKey>String</d2p1:BrandKey>
      <d2p1:BrandName>String</d2p1:BrandName>
      <d2p1:Count>0</d2p1:Count>
    </d2p1:BrandDto>
  </Brands>
  <CategoryDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:CategoryId>0</d2p1:CategoryId>
    <d2p1:CategoryLabel>String</d2p1:CategoryLabel>
    <d2p1:Code>String</d2p1:Code>
    <d2p1:Keywords>String</d2p1:Keywords>
    <d2p1:Metadata>String</d2p1:Metadata>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:PId>0</d2p1:PId>
    <d2p1:Tags>String</d2p1:Tags>
    <d2p1:Title>String</d2p1:Title>
  </CategoryDetail>
  <PostSetting xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:AddressLevel>None</d2p1:AddressLevel>
    <d2p1:MaxMediaCount>0</d2p1:MaxMediaCount>
    <d2p1:TimeBasedVariantYn>false</d2p1:TimeBasedVariantYn>
    <d2p1:UseBrandYn>None</d2p1:UseBrandYn>
    <d2p1:UseCatalogProduct>None</d2p1:UseCatalogProduct>
    <d2p1:UseCondition>None</d2p1:UseCondition>
    <d2p1:UseMapInPost>None</d2p1:UseMapInPost>
    <d2p1:UseNoPrice>false</d2p1:UseNoPrice>
    <d2p1:UsePostDesc>None</d2p1:UsePostDesc>
    <d2p1:UsePostSummary>None</d2p1:UsePostSummary>
    <d2p1:UseSaleType>None</d2p1:UseSaleType>
    <d2p1:UseSinglePrice>false</d2p1:UseSinglePrice>
    <d2p1:UseStartEndDate>false</d2p1:UseStartEndDate>
    <d2p1:UseStock>None</d2p1:UseStock>
    <d2p1:UseVariant>false</d2p1:UseVariant>
    <d2p1:VariantAtt1Def>0</d2p1:VariantAtt1Def>
    <d2p1:VariantAtt2Def>0</d2p1:VariantAtt2Def>
    <d2p1:VariantAtt3Def>0</d2p1:VariantAtt3Def>
    <d2p1:VariantAtt4Def>0</d2p1:VariantAtt4Def>
  </PostSetting>
  <VAtt1DefId>0</VAtt1DefId>
  <VAtt2DefId>0</VAtt2DefId>
  <VAtt3DefId>0</VAtt3DefId>
  <VAtt4DefId>0</VAtt4DefId>
</ExtGetSmCategoryDetailResponse>