PDF Export

getArticleComplete

Returns all distribution article numbers, which are currently available in the VHS/3 system, with their detailed informations.

  • Object: /net/dsb/vhs3/ArticleMaster
  • Method: getArticleComplete
  • Version: 1.0.0

Parameter

Name Type / LenghtOpt. / Man.Description
eshop-article-flag AN / 1 O Select only the articles with a certain eshop-article-flag“.
cc-article-flag AN / 1 O Select only the articles with a certain “cc-article-flag”.
from-hit N / 5 O If the result set should be reduced, the you can pass here then first hit, that should be returned. Default is 1.
max-hit-count N / 5 O Number of the max. returned hits. Default is 100.
price-list AN / 4 O 0 .. n price-list elements for which you want to query the prices.
country-code-type AN / 3 O Controls which types of country-code will be returned. car = triple-digit int.car country-code iso = two-digit ISO countycode
timestamp-articleupdated-sinceD K Timestamp in format xs:dateTime All changes since this timestamp (inclusive) are returned.
include-inactive-articles AN / 1 O Y = response includes deactivated articles N = response includes only active articles(default)
with-sc BOOL O return source code with price lists (true/false) default: false

To get all data sets the parameters from-hit and max-hit-count are used. You have to read data until you get less than max-hit-count results with the other parameters unchanged.

Example:

  • 1. Request: from-hit=1, max-hit-count=100 –> 100 Results
  • 2. Request: from-hit=101, max-hit-count=100 –> 56 Results
  • –> Complete

Response Element

List of article XML fragments (see below).

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="vhs/3" >
  <header>
    <client>4711</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <eshop-article-flag>Y</eshop-article-flag>
    <cc-article-flag>J</cc-article-flag>
    <from-hit>10</from-hit>
    <max-hit-count>10</max-hit-count>
    <price-list>PLE1</price-list>
    <country-code-type>iso</country-code-type>
    <timestamp-article-updated-since>2010-07-21T12:34:00</timestamp-article-updated-since>
  </body>
</message>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="vhs/3">
  <header>
    <client>4711</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <article>...</article>
    <article>...</article>
    <article>...</article>
  </body>
</message>

Response Structure

This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information