Veetro Web Service Methods


Click here for a complete list of operations.

GetCatalogItemCategorySearchResults

[Permission: Employee]
Returns the CatalogItemCategories.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
StartIndex:
FetchSize:
SortColumn:
Ascending:
Keywords:

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetCatalogItemCategorySearchResults"

<?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>
    <GetCatalogItemCategorySearchResults xmlns="http://schema.veetro.com">
      <StartIndex>int</StartIndex>
      <FetchSize>int</FetchSize>
      <SortColumn>string</SortColumn>
      <Ascending>boolean</Ascending>
      <Keywords>string</Keywords>
    </GetCatalogItemCategorySearchResults>
  </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>
    <GetCatalogItemCategorySearchResultsResponse xmlns="http://schema.veetro.com">
      <GetCatalogItemCategorySearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <CatalogItemCategory>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
            <Name>string</Name>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
          </CatalogItemCategory>
          <CatalogItemCategory>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
            <Name>string</Name>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
          </CatalogItemCategory>
        </Results>
      </GetCatalogItemCategorySearchResultsResult>
    </GetCatalogItemCategorySearchResultsResponse>
  </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 /xml HTTP/1.1
Host: admin.worketc.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:Body>
    <GetCatalogItemCategorySearchResults xmlns="http://schema.veetro.com">
      <StartIndex>int</StartIndex>
      <FetchSize>int</FetchSize>
      <SortColumn>string</SortColumn>
      <Ascending>boolean</Ascending>
      <Keywords>string</Keywords>
    </GetCatalogItemCategorySearchResults>
  </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>
    <GetCatalogItemCategorySearchResultsResponse xmlns="http://schema.veetro.com">
      <GetCatalogItemCategorySearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <CatalogItemCategory>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
            <Name>string</Name>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
          </CatalogItemCategory>
          <CatalogItemCategory>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
            <Name>string</Name>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
          </CatalogItemCategory>
        </Results>
      </GetCatalogItemCategorySearchResultsResult>
    </GetCatalogItemCategorySearchResultsResponse>
  </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 /xml/GetCatalogItemCategorySearchResults?StartIndex=string&FetchSize=string&SortColumn=string&Ascending=string&Keywords=string HTTP/1.1
Host: admin.worketc.com

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

<?xml version="1.0" encoding="utf-8"?>
<SearchResultOfCatalogItemCategory xmlns="http://schema.veetro.com">
  <RecordCount>int</RecordCount>
  <Description>string</Description>
  <SQL>string</SQL>
  <FetchSize>int</FetchSize>
  <Page>int</Page>
  <StartIndex>int</StartIndex>
  <EndIndex>int</EndIndex>
  <Results>
    <CatalogItemCategory>
      <CatalogItemCategoryID>int</CatalogItemCategoryID>
      <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
      <Name>string</Name>
      <Delete>boolean</Delete>
      <CustomFields>
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </CatalogItemCategory>
    <CatalogItemCategory>
      <CatalogItemCategoryID>int</CatalogItemCategoryID>
      <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
      <Name>string</Name>
      <Delete>boolean</Delete>
      <CustomFields>
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </CatalogItemCategory>
  </Results>
</SearchResultOfCatalogItemCategory>

HTTP POST

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

POST /xml/GetCatalogItemCategorySearchResults HTTP/1.1
Host: admin.worketc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

StartIndex=string&FetchSize=string&SortColumn=string&Ascending=string&Keywords=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SearchResultOfCatalogItemCategory xmlns="http://schema.veetro.com">
  <RecordCount>int</RecordCount>
  <Description>string</Description>
  <SQL>string</SQL>
  <FetchSize>int</FetchSize>
  <Page>int</Page>
  <StartIndex>int</StartIndex>
  <EndIndex>int</EndIndex>
  <Results>
    <CatalogItemCategory>
      <CatalogItemCategoryID>int</CatalogItemCategoryID>
      <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
      <Name>string</Name>
      <Delete>boolean</Delete>
      <CustomFields>
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </CatalogItemCategory>
    <CatalogItemCategory>
      <CatalogItemCategoryID>int</CatalogItemCategoryID>
      <CatalogItemCategoryID_Parent>int</CatalogItemCategoryID_Parent>
      <Name>string</Name>
      <Delete>boolean</Delete>
      <CustomFields>
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </CatalogItemCategory>
  </Results>
</SearchResultOfCatalogItemCategory>