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 .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 /Sm/GetSearchSetting HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSmSearchSettingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Code>String</Code>
</GetSmSearchSettingRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSmSearchSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:AttibuteDefs>
      <d2p1:SmAttributeDefDTO>
        <d2p1:AttributeDefId>0</d2p1:AttributeDefId>
        <d2p1:LabelText>String</d2p1:LabelText>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Required>false</d2p1:Required>
        <d2p1:AType>Text</d2p1:AType>
        <d2p1:AllText>String</d2p1:AllText>
        <d2p1:AnyText>String</d2p1:AnyText>
        <d2p1:AttributeDatas>
          <d2p1:SmAttributeDataDTO>
            <d2p1:Count>0</d2p1:Count>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:SmAttributeDataDTO>
        </d2p1:AttributeDatas>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:DefaultValue>String</d2p1:DefaultValue>
        <d2p1:IType>Text</d2p1:IType>
        <d2p1:MaxValue>0</d2p1:MaxValue>
        <d2p1:MinValue>0</d2p1:MinValue>
        <d2p1:Required>false</d2p1:Required>
        <d2p1:SType>None</d2p1:SType>
      </d2p1:SmAttributeDefDTO>
    </d2p1:AttibuteDefs>
    <d2p1:Brands>
      <d2p1:BrandDto>
        <d2p1:BrandId>0</d2p1:BrandId>
        <d2p1:BrandKey>String</d2p1:BrandKey>
        <d2p1:BrandName>String</d2p1:BrandName>
        <d2p1:Count>0</d2p1:Count>
      </d2p1:BrandDto>
    </d2p1:Brands>
    <d2p1:BreadCrumb>
      <d2p1:SmCategoryMetaDTO>
        <d2p1:ActiveYn>false</d2p1:ActiveYn>
        <d2p1:CategoryId>0</d2p1:CategoryId>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PId>0</d2p1:PId>
        <d2p1:CType>None</d2p1:CType>
        <d2p1:Count>0</d2p1:Count>
        <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
        <d2p1:NType>None</d2p1:NType>
        <d2p1:Order>0</d2p1:Order>
        <d2p1:SearchYn>false</d2p1:SearchYn>
        <d2p1:Selected>false</d2p1:Selected>
        <d2p1:SubCats>
          <d2p1:SmCategoryMetaDTO>
            <d2p1:ActiveYn>false</d2p1:ActiveYn>
            <d2p1:CategoryId>0</d2p1:CategoryId>
            <d2p1:Code>String</d2p1:Code>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:PId>0</d2p1:PId>
            <d2p1:CType>None</d2p1:CType>
            <d2p1:Count>0</d2p1:Count>
            <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
            <d2p1:NType>None</d2p1:NType>
            <d2p1:Order>0</d2p1:Order>
            <d2p1:SearchYn>false</d2p1:SearchYn>
            <d2p1:Selected>false</d2p1:Selected>
            <d2p1:SubCats>
              <d2p1:SmCategoryMetaDTO>
                <d2p1:ActiveYn>false</d2p1:ActiveYn>
                <d2p1:CategoryId>0</d2p1:CategoryId>
                <d2p1:Code>String</d2p1:Code>
                <d2p1:Name>String</d2p1:Name>
                <d2p1:PId>0</d2p1:PId>
                <d2p1:CType>None</d2p1:CType>
                <d2p1:Count>0</d2p1:Count>
                <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
                <d2p1:NType>None</d2p1:NType>
                <d2p1:Order>0</d2p1:Order>
                <d2p1:SearchYn>false</d2p1:SearchYn>
                <d2p1:Selected>false</d2p1:Selected>
                <d2p1:SubCats i:nil="true" />
              </d2p1:SmCategoryMetaDTO>
            </d2p1:SubCats>
          </d2p1:SmCategoryMetaDTO>
        </d2p1:SubCats>
      </d2p1:SmCategoryMetaDTO>
    </d2p1:BreadCrumb>
    <d2p1:PtSetting>
      <d2p1:ActiveYn>false</d2p1:ActiveYn>
      <d2p1:Desciption>String</d2p1:Desciption>
      <d2p1:FriendlyUrl>String</d2p1:FriendlyUrl>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PostTypeId>0</d2p1:PostTypeId>
      <d2p1:DefaultCommissionRate>0</d2p1:DefaultCommissionRate>
      <d2p1:FriendlyUrlSource>String</d2p1:FriendlyUrlSource>
      <d2p1:PtAllowSaleYn>false</d2p1:PtAllowSaleYn>
      <d2p1:SearchAddressLevel>None</d2p1:SearchAddressLevel>
      <d2p1:SearchConditionYn>false</d2p1:SearchConditionYn>
      <d2p1:SearchDefault>Post</d2p1:SearchDefault>
      <d2p1:SearchMapDefaultScale>0</d2p1:SearchMapDefaultScale>
      <d2p1:SearchMapMethod>Post</d2p1:SearchMapMethod>
      <d2p1:SearchMapOnlyUsedCondition>false</d2p1:SearchMapOnlyUsedCondition>
      <d2p1:SearchPostOnMapYn>false</d2p1:SearchPostOnMapYn>
      <d2p1:SearchPostYn>false</d2p1:SearchPostYn>
      <d2p1:SearchSaleTypeYn>false</d2p1:SearchSaleTypeYn>
      <d2p1:SearchStoreOnMapYn>false</d2p1:SearchStoreOnMapYn>
      <d2p1:SearchStoreYn>false</d2p1:SearchStoreYn>
      <d2p1:VirtualDepartmentSource>String</d2p1:VirtualDepartmentSource>
    </d2p1:PtSetting>
    <d2p1:VariantDefs>
      <d2p1:SmAttributeDefDTO>
        <d2p1:AttributeDefId>0</d2p1:AttributeDefId>
        <d2p1:LabelText>String</d2p1:LabelText>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Required>false</d2p1:Required>
        <d2p1:AType>Text</d2p1:AType>
        <d2p1:AllText>String</d2p1:AllText>
        <d2p1:AnyText>String</d2p1:AnyText>
        <d2p1:AttributeDatas>
          <d2p1:SmAttributeDataDTO>
            <d2p1:Count>0</d2p1:Count>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:SmAttributeDataDTO>
        </d2p1:AttributeDatas>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:DefaultValue>String</d2p1:DefaultValue>
        <d2p1:IType>Text</d2p1:IType>
        <d2p1:MaxValue>0</d2p1:MaxValue>
        <d2p1:MinValue>0</d2p1:MinValue>
        <d2p1:Required>false</d2p1:Required>
        <d2p1:SType>None</d2p1:SType>
      </d2p1:SmAttributeDefDTO>
    </d2p1:VariantDefs>
  </Settings>
</GetSmSearchSettingResponse>