PDF Export

getByBpNumber (Version 3)

  • Object: /net/dsb/avs3/SubscriptionOrder
  • Method: getByBpNumber
  • Version: 3.0.0
  • Fuba: /DSB/ISM_E_SEL_VBELN_TO_GP

This method retreives all subscription orders related to the referred business-partner number. This includes all orders that relates to this partner in any role and includes orders where this partner was related in the past. You have to check the returned orders if you only want orders where the partner is currently related. The result can obtain none, one or many subscription orders. The search is within the active and the inactive orders, dependent on the element only-active-subscription. If no return-address-type is in the request, the WE is sent back as default.

Important hint:

It is possible to customize which attributes (order or business-partner) are returned in the response. This is maintained in the customizing table /DSB/JET_MERK_RE or /DSB/JET_MERK_GP in AVS/3. Please get in touch with customer service if you would like to add additional values. All values are returned if the wildcard (*) is set.

Parameter

Name Type / Length Mandatory? Description
bp-number AN / 10 y Business Partner Number(1…10)
mix-type AN / 2 n mix type
from-hit N n If the result set should be reduced, the you can pass here then first hit, that should be returned. Default is 0.
max-hit-count N / 4 n Number of the max.returned hits(1-00). Default is 100.
only-active-subscription AN / 1 n return only the active subscriptions
Y = Yes(Default)
N = no

Additional common selection parameter:

Name Type / max. length mandatory? Description
publication AN / 8 n Code for the magazine (publication), which should be observed in search of
return-address-type AN / 2 n Define which role will be available in the response (AG, WE, VM, RE)
return-address-at-time AN / 2 y 'L' = Address at last shipment date
'A' = active address
'Z' = Address at future shipment date
return-extended-communication-dataAN /1 n return extended communication data ( Y / N (Default) )
return-renewal-payment-data AN / 1 n Return additional renewal payment data ( Y / N (Default) )
return-renewal-issue-remaining AN / 1 n Y = Yes Return remaining isssues regarding the current cycle Otherwise return remaining issues regarding the whole subscription
return-current-suspension-data AN / 1 n Return additional data of the current suspension. If there is no current suspension the next in time is returned. ( Y / N (Default) )
return-extended-premium-data AN / 1 n Return extended premium data ( Y / N (Default) )
return-holiday-addresses BETA AN / 1 k BETA
Returns additional holiday addresses ( Y / N (Default) )

Response Element

XML-Structure 'subscription-order'. This structure meet the description of 'new-subscription'

Example Request

<message version="1.0" system="avs/3" >
  <header>
    <client>999</client>
    <avs3-sales-organization>9999</avs3-sales-organization>
    <avs3-service-provider>123</avs3-service-provider>
  </header>
  <body>
    <bp-number>1003701415</bp-number>
    <publication></publication>
    <mix-type></mix-type>
    <return-address-type>AG</return-address-type>
    <return-address-type>RE</return-address-type>
    <return-address-type>WE</return-address-type>
    <return-address-at-time>L</return-address-at-time>
    <return-extended-communication-data>Y</return-extended-communication-data>
    <return-renewal-payment-data>Y</return-renewal-payment-data>
    <return-renewal-issue-remaining>N</return-renewal-issue-remaining>
    <return-current-suspension-data>N</return-current-suspension-data>
    <return-extended-premium-data>N</return-extended-premium-data>
    <from-hit>100</from-hit>
    <max-hit-count>100</max-hit-count>
    <only-active-subscription>N</only-active-subscription>
  </body>
</message>

Example Response

<message version="1.0" system="avs/3">
  <header>
    <client>999</client>
    <avs3-sales-organization>9999</avs3-sales-organization>
    <avs3-service-provider>123</avs3-service-provider>
  </header>
  <body>
    <subscription-order>
      ...
    </subscription-order>
  </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