PDF Export

getByOrderAttribute(Version 3)

  • Object: /net/dsb/avs3/SubscriptionOrder
  • Method: getByOrderAttribute
  • Version: 3.0.0
  • Fuba: /DSB/ISM_E_SEL_MERKM

This method sends all subscription orders back which have a particular order attribute. The return can obtain one, several or none subscription orders. Besides it is searched for within active as well as inactive orders. 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 Mandat. Description
order-attribute n.a. y XML-Fragment ‚order-attribute‘ see section 6.6.
mix-type AN / 2 n mix type

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>
    <order-attribute>
      <type>EXTKEY</type>
      <value>1234567890</value>
    </order-attribute>
    <publication></publication>
    <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>N</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>
  </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