ApexERPHost

<back to all web services

GetECommerceFilters

Requires Authentication
The following routes are available for this service:
GET/eCommerce/Filters
GetECommerceFilters Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryint?No
BranchIdqueryint?No
LangquerystringNo
GetECommerceFiltersResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ECommerceFilterGroup>No
ECommerceFilterGroup Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
LocationformstringNo
FiltersformList<ECommerceFilter>No
ECommerceFilter Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeformintNo
NameformstringNo
QueryParamformstringNo
ValuesformList<ECommerceFilterValue>No
DefaultValueformECommerceFilterValueNo
ECommerceFilterValue Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
NameformstringNo
MinValueformdecimal?No
MaxValueformdecimal?No
ParentValueformstringNo
ImgLinkformstringNo
SortformstringNo
SlugformstringNo
ShortDescriptionformstringNo
DescriptionformstringNo
ShortDescription2formstringNo
Description2formstringNo
VideoLinkformstringNo
ImageLinksformList<string>No
MinCountformdecimal?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.

GET /eCommerce/Filters HTTP/1.1 
Host: 10.10.0.107 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetECommerceFiltersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.ECommerce">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <ECommerceFilterGroup>
      <Id>0</Id>
      <Name>String</Name>
      <Location>String</Location>
      <Filters>
        <ECommerceFilter>
          <Id>0</Id>
          <Type>0</Type>
          <Name>String</Name>
          <QueryParam>String</QueryParam>
          <Values>
            <ECommerceFilterValue>
              <Value>String</Value>
              <Name>String</Name>
              <MinValue>0</MinValue>
              <MaxValue>0</MaxValue>
              <ParentValue>String</ParentValue>
              <ImgLink>String</ImgLink>
              <Sort>String</Sort>
              <Slug>String</Slug>
              <ShortDescription>String</ShortDescription>
              <Description>String</Description>
              <ShortDescription2>String</ShortDescription2>
              <Description2>String</Description2>
              <VideoLink>String</VideoLink>
              <ImageLinks xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>String</d8p1:string>
              </ImageLinks>
              <MinCount>0</MinCount>
            </ECommerceFilterValue>
          </Values>
          <DefaultValue>
            <Value>String</Value>
            <Name>String</Name>
            <MinValue>0</MinValue>
            <MaxValue>0</MaxValue>
            <ParentValue>String</ParentValue>
            <ImgLink>String</ImgLink>
            <Sort>String</Sort>
            <Slug>String</Slug>
            <ShortDescription>String</ShortDescription>
            <Description>String</Description>
            <ShortDescription2>String</ShortDescription2>
            <Description2>String</Description2>
            <VideoLink>String</VideoLink>
            <ImageLinks xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </ImageLinks>
            <MinCount>0</MinCount>
          </DefaultValue>
        </ECommerceFilter>
      </Filters>
    </ECommerceFilterGroup>
  </Result>
</GetECommerceFiltersResponse>