CMSWebService Web Service

CMSWebService

Click here for a complete list of operations.

GetCategoryListing_v3

Display categories listing in home screen for given company.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
companyId:
tokenId:
refSellerId:
imageWidth:
source:
LanguageId:
Filter:
categoryId:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CMSWebService.asmx HTTP/1.1
Host: posservicev21t24.imarketvend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://microsoft.com/webservices/GetCategoryListing_v3"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthSoapHd xmlns="http://microsoft.com/webservices/">
      <strUserName>string</strUserName>
      <strPassword>string</strPassword>
    </AuthSoapHd>
  </soap:Header>
  <soap:Body>
    <GetCategoryListing_v3 xmlns="http://microsoft.com/webservices/">
      <companyId>string</companyId>
      <tokenId>string</tokenId>
      <refSellerId>string</refSellerId>
      <imageWidth>string</imageWidth>
      <source>string</source>
      <LanguageId>string</LanguageId>
      <Filter>string</Filter>
      <categoryId>string</categoryId>
    </GetCategoryListing_v3>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCategoryListing_v3Response xmlns="http://microsoft.com/webservices/">
      <GetCategoryListing_v3Result>
        <CategoryListing>
          <ChildCategories>
            <CategoryListing xsi:nil="true" />
            <CategoryListing xsi:nil="true" />
          </ChildCategories>
          <Brands>
            <Brand xsi:nil="true" />
            <Brand xsi:nil="true" />
          </Brands>
          <CategoryId>string</CategoryId>
          <CategoryName>string</CategoryName>
          <CategoryImage>string</CategoryImage>
          <MapUrlRewrite>string</MapUrlRewrite>
          <IsProductContainer>string</IsProductContainer>
          <ParentId>string</ParentId>
          <refCategoryType>int</refCategoryType>
        </CategoryListing>
        <CategoryListing>
          <ChildCategories>
            <CategoryListing xsi:nil="true" />
            <CategoryListing xsi:nil="true" />
          </ChildCategories>
          <Brands>
            <Brand xsi:nil="true" />
            <Brand xsi:nil="true" />
          </Brands>
          <CategoryId>string</CategoryId>
          <CategoryName>string</CategoryName>
          <CategoryImage>string</CategoryImage>
          <MapUrlRewrite>string</MapUrlRewrite>
          <IsProductContainer>string</IsProductContainer>
          <ParentId>string</ParentId>
          <refCategoryType>int</refCategoryType>
        </CategoryListing>
      </GetCategoryListing_v3Result>
    </GetCategoryListing_v3Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CMSWebService.asmx HTTP/1.1
Host: posservicev21t24.imarketvend.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthSoapHd xmlns="http://microsoft.com/webservices/">
      <strUserName>string</strUserName>
      <strPassword>string</strPassword>
    </AuthSoapHd>
  </soap12:Header>
  <soap12:Body>
    <GetCategoryListing_v3 xmlns="http://microsoft.com/webservices/">
      <companyId>string</companyId>
      <tokenId>string</tokenId>
      <refSellerId>string</refSellerId>
      <imageWidth>string</imageWidth>
      <source>string</source>
      <LanguageId>string</LanguageId>
      <Filter>string</Filter>
      <categoryId>string</categoryId>
    </GetCategoryListing_v3>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCategoryListing_v3Response xmlns="http://microsoft.com/webservices/">
      <GetCategoryListing_v3Result>
        <CategoryListing>
          <ChildCategories>
            <CategoryListing xsi:nil="true" />
            <CategoryListing xsi:nil="true" />
          </ChildCategories>
          <Brands>
            <Brand xsi:nil="true" />
            <Brand xsi:nil="true" />
          </Brands>
          <CategoryId>string</CategoryId>
          <CategoryName>string</CategoryName>
          <CategoryImage>string</CategoryImage>
          <MapUrlRewrite>string</MapUrlRewrite>
          <IsProductContainer>string</IsProductContainer>
          <ParentId>string</ParentId>
          <refCategoryType>int</refCategoryType>
        </CategoryListing>
        <CategoryListing>
          <ChildCategories>
            <CategoryListing xsi:nil="true" />
            <CategoryListing xsi:nil="true" />
          </ChildCategories>
          <Brands>
            <Brand xsi:nil="true" />
            <Brand xsi:nil="true" />
          </Brands>
          <CategoryId>string</CategoryId>
          <CategoryName>string</CategoryName>
          <CategoryImage>string</CategoryImage>
          <MapUrlRewrite>string</MapUrlRewrite>
          <IsProductContainer>string</IsProductContainer>
          <ParentId>string</ParentId>
          <refCategoryType>int</refCategoryType>
        </CategoryListing>
      </GetCategoryListing_v3Result>
    </GetCategoryListing_v3Response>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /CMSWebService.asmx/GetCategoryListing_v3?companyId=string&tokenId=string&refSellerId=string&imageWidth=string&source=string&LanguageId=string&Filter=string&categoryId=string HTTP/1.1
Host: posservicev21t24.imarketvend.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCategoryListing xmlns="http://microsoft.com/webservices/">
  <CategoryListing>
    <ChildCategories>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
    </ChildCategories>
    <Brands>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
    </Brands>
    <CategoryId>string</CategoryId>
    <CategoryName>string</CategoryName>
    <CategoryImage>string</CategoryImage>
    <MapUrlRewrite>string</MapUrlRewrite>
    <IsProductContainer>string</IsProductContainer>
    <ParentId>string</ParentId>
    <refCategoryType>int</refCategoryType>
  </CategoryListing>
  <CategoryListing>
    <ChildCategories>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
    </ChildCategories>
    <Brands>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
    </Brands>
    <CategoryId>string</CategoryId>
    <CategoryName>string</CategoryName>
    <CategoryImage>string</CategoryImage>
    <MapUrlRewrite>string</MapUrlRewrite>
    <IsProductContainer>string</IsProductContainer>
    <ParentId>string</ParentId>
    <refCategoryType>int</refCategoryType>
  </CategoryListing>
</ArrayOfCategoryListing>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /CMSWebService.asmx/GetCategoryListing_v3 HTTP/1.1
Host: posservicev21t24.imarketvend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

companyId=string&tokenId=string&refSellerId=string&imageWidth=string&source=string&LanguageId=string&Filter=string&categoryId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCategoryListing xmlns="http://microsoft.com/webservices/">
  <CategoryListing>
    <ChildCategories>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
    </ChildCategories>
    <Brands>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
    </Brands>
    <CategoryId>string</CategoryId>
    <CategoryName>string</CategoryName>
    <CategoryImage>string</CategoryImage>
    <MapUrlRewrite>string</MapUrlRewrite>
    <IsProductContainer>string</IsProductContainer>
    <ParentId>string</ParentId>
    <refCategoryType>int</refCategoryType>
  </CategoryListing>
  <CategoryListing>
    <ChildCategories>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
      <CategoryListing>
        <ChildCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Brands d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CategoryId>string</CategoryId>
        <CategoryName>string</CategoryName>
        <CategoryImage>string</CategoryImage>
        <MapUrlRewrite>string</MapUrlRewrite>
        <IsProductContainer>string</IsProductContainer>
        <ParentId>string</ParentId>
        <refCategoryType>int</refCategoryType>
      </CategoryListing>
    </ChildCategories>
    <Brands>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
      <Brand>
        <BrandId>string</BrandId>
        <BrandName>string</BrandName>
        <BrandLogo>string</BrandLogo>
      </Brand>
    </Brands>
    <CategoryId>string</CategoryId>
    <CategoryName>string</CategoryName>
    <CategoryImage>string</CategoryImage>
    <MapUrlRewrite>string</MapUrlRewrite>
    <IsProductContainer>string</IsProductContainer>
    <ParentId>string</ParentId>
    <refCategoryType>int</refCategoryType>
  </CategoryListing>
</ArrayOfCategoryListing>