WebServices3 Web Service

WebServices3

Click here for a complete list of operations.

Catalog_Category_FindByCustomPage

Test

The test form is only available for requests from the local machine.

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 /WebServices3.asmx HTTP/1.1
Host: demo.bvcommerce.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3/Catalog_Category_FindByCustomPage"

<?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>
    <Catalog_Category_FindByCustomPage xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <customPageId>string</customPageId>
    </Catalog_Category_FindByCustomPage>
  </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>
    <Catalog_Category_FindByCustomPageResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <Catalog_Category_FindByCustomPageResult>
        <ParentId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</ParentId>
        <Name xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Name>
        <MenuName xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MenuName>
        <Description xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Description>
        <ShortDescription xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</ShortDescription>
        <DisplaySortOrder xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">None or ManualOrder or ProductName or ProductPriceAscending or ProductPriceDescending or ManufacturerName or CreationDateDescending or Popularity or Rating</DisplaySortOrder>
        <SourceType xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">Manual or ByRules or CustomLink or CustomPage</SourceType>
        <SortOrder xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">int</SortOrder>
        <MetaKeywords xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MetaKeywords>
        <MetaDescription xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MetaDescription>
        <MetaTitle xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MetaTitle>
        <ImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</ImageUrl>
        <BannerImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</BannerImageUrl>
        <LatestProductCount xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">int</LatestProductCount>
        <CustomPageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</CustomPageUrl>
        <CustomPageOpenInNewWindow xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</CustomPageOpenInNewWindow>
        <MenuOffImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MenuOffImageUrl>
        <MenuOnImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MenuOnImageUrl>
        <ShowInTopMenu xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</ShowInTopMenu>
        <Hidden xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</Hidden>
        <TemplateName xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</TemplateName>
        <PreContentColumnId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</PreContentColumnId>
        <PostContentColumnId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</PostContentColumnId>
        <RewriteUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</RewriteUrl>
        <ShowTitle xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</ShowTitle>
        <Criteria xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Criteria>
        <CustomPageId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</CustomPageId>
        <PreTransformDescription xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</PreTransformDescription>
        <Keywords xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Keywords>
        <CustomerChangeableSortOrder xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</CustomerChangeableSortOrder>
      </Catalog_Category_FindByCustomPageResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
    </Catalog_Category_FindByCustomPageResponse>
  </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 /WebServices3.asmx HTTP/1.1
Host: demo.bvcommerce.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>
    <Catalog_Category_FindByCustomPage xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <customPageId>string</customPageId>
    </Catalog_Category_FindByCustomPage>
  </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>
    <Catalog_Category_FindByCustomPageResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <Catalog_Category_FindByCustomPageResult>
        <ParentId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</ParentId>
        <Name xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Name>
        <MenuName xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MenuName>
        <Description xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Description>
        <ShortDescription xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</ShortDescription>
        <DisplaySortOrder xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">None or ManualOrder or ProductName or ProductPriceAscending or ProductPriceDescending or ManufacturerName or CreationDateDescending or Popularity or Rating</DisplaySortOrder>
        <SourceType xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">Manual or ByRules or CustomLink or CustomPage</SourceType>
        <SortOrder xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">int</SortOrder>
        <MetaKeywords xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MetaKeywords>
        <MetaDescription xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MetaDescription>
        <MetaTitle xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MetaTitle>
        <ImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</ImageUrl>
        <BannerImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</BannerImageUrl>
        <LatestProductCount xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">int</LatestProductCount>
        <CustomPageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</CustomPageUrl>
        <CustomPageOpenInNewWindow xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</CustomPageOpenInNewWindow>
        <MenuOffImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MenuOffImageUrl>
        <MenuOnImageUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</MenuOnImageUrl>
        <ShowInTopMenu xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</ShowInTopMenu>
        <Hidden xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</Hidden>
        <TemplateName xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</TemplateName>
        <PreContentColumnId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</PreContentColumnId>
        <PostContentColumnId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</PostContentColumnId>
        <RewriteUrl xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</RewriteUrl>
        <ShowTitle xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</ShowTitle>
        <Criteria xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Criteria>
        <CustomPageId xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</CustomPageId>
        <PreTransformDescription xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</PreTransformDescription>
        <Keywords xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">string</Keywords>
        <CustomerChangeableSortOrder xmlns="http://www.bvsoftware.com/bvc5/schemas/2005/09/01/Catalog/Category">boolean</CustomerChangeableSortOrder>
      </Catalog_Category_FindByCustomPageResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
    </Catalog_Category_FindByCustomPageResponse>
  </soap12:Body>
</soap12:Envelope>