PDF Export

Example get subscription requests

All the examples show requests of the test client 370.

plain get request

GET https://wsportal-tst.dsb.net/rest/370/subscriptions/4019874884

Response:

{
   "orderNumber": "4019874884",
   "dsbUrposLief": "000001",
   "publication": "00000300",
   "publicationName": "DSB Magazine",
   "edition": "00000300",
   "mixType": "01",
   "purchaseFrequency": "VA",
   "deliveryType": "DM",
   "orderStatus": "A",
   "orderCurrency": "GBP",
   "issueNrFrom": "000000319",
   "validFrom": "2017-07-08",
   "promotionSource": "RLD0708",
   "referenceDoc": "DSB1111111",
   "custOrderDate": "2017-07-03",
   "subscrPhase": "F1",
   "priceKey": "CP01",
   "billingFrequency": "16",
   "quantity": "1",
   "salesOrganization": "0100",
   "currentDunningLevel": "00",
   "conditionTermCommitmentPeriod": "12",
   "conditionTermCancelationPeriod": "1",
   "conditionTermRenewal": "1",
   "salesSource": "REN1",
   "advertisingMedium": "RLD0708",
   "salesDocumentType": "REN",
   "validFromEvt": "2017-07-13",
   "validFromOnSaleDate": "2017-07-26",
   "contractAccountBalance": "0.00",
   "postageKey": "DM",
   "renewal":    {
      "expiryDate": "2018-10-25",
      "expiryIssueNr": "000000334",
      "currentCycleNumberOfIssues": 16,
      "currentCycleExpiryDate": "2018-10-25",
      "currentCycleExpiryIssueNr": "000000334",
      "currentCycleStartDate": "2017-07-26",
      "currentCycleStartIssueNr": "000000319",
      "currentCycleAcceptanceDate": "2017-07-03",
      "currentCyclePaidAmount": "27.65",
      "currentCycleBundlePaidAmount": "0.00",
      "orderCurrency": "GBP",
      "numberIssuesRemaining": 14,
      "autoRenewal": false,
      "autoRenewalNextPaymentAmount": 0,
      "autoRenewalLastPaymentAmount": 0
   },
   "businessPartners": [   {
      "role": "WE",
      "bpNumber": "1044444444",
      "lastName1": "Smith",
      "salutationCode": "99",
      "fullSalutation": "Dear Sirs",
      "company1": "Smith",
      "company2": "A",
      "addressLine1": "54 Sunshine Street",
      "addressLine2": "Saltford",
      "regionCode": "SO",
      "regionText": "Somerset",
      "zipcode": "SW1E 6LB",
      "city": "BRISTOL",
      "countryCode": "GB",
      "country": "United Kingdom",
      "advertisement": "Y",
      "blockTag": "N"
   }],
   "orderAttributes":    [
      {
         "type": "EXTREF",
         "value": "DSB1111111"
      }, {
         "type": "OPINE3",
         "value": "NA"
      }, {
         "type": "OPINEW",
         "value": "NA"
      }, {
         "type": "OPINM3",
         "value": "NA"
      }, {
         "type": "OPINMW",
         "value": "NA"
      }, {
         "type": "OPINT3",
         "value": "NA"
      }, {
         "type": "OPINTW",
         "value": "NA"
      }
   ]
}

read additional business partners

To read additional partners of the subscription you can specify the returnAddressType parameter.

For example: Read the AG and WE of a subscription: GET https://wsportal-tst.dsb.net/rest/370/subscriptions/4019874884

Response:

{
   "orderNumber": "4019874884",
   "dsbUrposLief": "000001",
   "publication": "00000300",
   "publicationName": "DSB Magazine",
   "edition": "00000300",
   "mixType": "01",
   "purchaseFrequency": "VA",
   "deliveryType": "DM",
   "orderStatus": "A",
   "orderCurrency": "GBP",
   "issueNrFrom": "000000319",
   "validFrom": "2017-07-08",
   "promotionSource": "RLD0708",
   "referenceDoc": "DSB1111111",
   "custOrderDate": "2017-07-03",
   "subscrPhase": "F1",
   "priceKey": "CP01",
   "billingFrequency": "16",
   "quantity": "1",
   "salesOrganization": "0100",
   "currentDunningLevel": "00",
   "conditionTermCommitmentPeriod": "12",
   "conditionTermCancelationPeriod": "1",
   "conditionTermRenewal": "1",
   "salesSource": "REN1",
   "advertisingMedium": "RLD0708",
   "salesDocumentType": "REN",
   "validFromEvt": "2017-07-13",
   "validFromOnSaleDate": "2017-07-26",
   "contractAccountBalance": "0.00",
   "postageKey": "DM",
   "renewal":    {
      "expiryDate": "2018-10-25",
      "expiryIssueNr": "000000334",
      "currentCycleNumberOfIssues": 16,
      "currentCycleExpiryDate": "2018-10-25",
      "currentCycleExpiryIssueNr": "000000334",
      "currentCycleStartDate": "2017-07-26",
      "currentCycleStartIssueNr": "000000319",
      "currentCycleAcceptanceDate": "2017-07-03",
      "currentCyclePaidAmount": "27.65",
      "currentCycleBundlePaidAmount": "0.00",
      "orderCurrency": "GBP",
      "numberIssuesRemaining": 14,
      "autoRenewal": false,
      "autoRenewalNextPaymentAmount": 0,
      "autoRenewalLastPaymentAmount": 0
   },
   "businessPartners":    [
            {
         "role": "WE",
         "bpNumber": "1040579662",
         "lastName1": "Smith",
         "salutationCode": "99",
         "fullSalutation": "Dear Sirs",
         "company1": "Smith",
         "company2": "A",
         "addressLine1": "54 Sunshine Street",
         "addressLine2": "Saltford",
         "regionCode": "SO",
         "regionText": "Somerset",
         "zipcode": "SW1E 6LB",
         "city": "BRISTOL",
         "countryCode": "GB",
         "country": "United Kingdom",
         "advertisement": "Y",
         "blockTag": "N"
      },
            {
         "role": "AG",
         "bpNumber": "1040579662",
         "lastName1": "Smith",
         "salutationCode": "99",
         "fullSalutation": "Dear Sirs",
         "company1": "Smith",
         "company2": "A",
         "addressLine1": "54 Sunshine Street",
         "addressLine2": "Saltford",
         "regionCode": "SO",
         "regionText": "Somerset",
         "zipcode": "SW1E 6LB",
         "city": "BRISTOL",
         "countryCode": "GB",
         "country": "United Kingdom",
         "advertisement": "Y",
         "blockTag": "N"
      }
   ],
   "orderAttributes":    [
      {
         "type": "EXTREF",
         "value": "GARD2145092"
      },  {
         "type": "OPINE3",
         "value": "NA"
      },  {
         "type": "OPINEW",
         "value": "NA"
      },  {
         "type": "OPINM3",
         "value": "NA"
      },  {
         "type": "OPINMW",
         "value": "NA"
      },  {
         "type": "OPINT3",
         "value": "NA"
      },   {
         "type": "OPINTW",
         "value": "NA"
      }
    ]
}
This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information