Inhaltsverzeichnis Auftrag kündigen Cancellation / Kündigung RENEWAL Kündigung eines Abo / cancellations Kündigung eines Abo rückgängig machen/ undoCancellation Kündigungs Infos Auftrag kündigen Cancellation / Kündigung RENEWAL Ein Renewal-Abo kündigen. Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/cancel-1.0.0 Fuba: /DSB/_ISM_E_REN_CANCEL URL POST: /rest/{client}/subscriptions/{orderNumber} Parameter Beschreibung client Mandantennummer orderNumber AVS Auftragsnummer sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) cancel-reasonKündigungsgrund (mandatory) cancel-type Art der Kündigung (mandatory): V (Kündigung am Ender der aktuelle Periode) or A (Kündigung sofort) trigger-message Wenn true, ccb Suite sendet eine Kündigungsbestätigungs Email / Brief (default: false) refund Wenn gesetzt, wird das Restguthaben automatisch zurück gezahlt. Corresponding SOAP Service: cancel. Response Der Response ist ein JSON Dokument mit dem Ergebnis. Element Beschreibung expiry-date Ablaufdatum expiry-description Beschreibung des Ablaufs cancellation-pendingWenn true, kann die Kündigung nicht sofor verarbeitet werden. Es wird eingesteurt und automatisch innerhalb der nächsten 7 Tage verarbeitet. message response message success true/false Kündigung eines Abo / cancellations Der Service ist grundsätzlich nur für Mitgliederstücke oder „einfache“ und kostenfreie Auftragspositionen (KPs) – z.B. Anzeigenfreistücke - zu verwenden Weitere Infos unter den bekannten Quellen im Wiki. Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/cancellation-1.0.0 Fuba: /DSB/_ISM_E_KUENDIGUNG URL POST: /rest/{client}/subscriptions/{orderNumber}/cancellations?sp={sp}&so={so}… ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer orderNumber C/10Abonummer sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) cancellationReasonC/3 Kündigungsgrund (optional) cancelNext B Kündigung zum nächstemöglichen Zeitpunkt channel C Kanal (nur bei cancleNext=true) cancelB optionales Kennzeichen: Ist es ein Storno? true: Es ist eine Stornierung eines noch nicht aktiven Abos (Abostatus IZ) vor der Aktivierung. Der Auftrag kommt nicht in den Status aktiv. Dies gilt nur, wenn das „cancellationDate“ NICHT gesetzt worden ist. Anderenfalls muss eine Fehlermeldung generiert werden. false (default ): Es ist eine Terminkündigung. cancellationDateC/10 Kündigung zum Datum YYYY-MM-DD Es ist die Vertriebsausgabe relevant, welche an oder direkt nach diesem Datum seinen EVT hat. (optional) issueNumberC/9 Kündigung zur Heftnummer HHHH/YYYY (optional) publicationDateC/10 Kündigung zum Erscheinungsdatum YYYY-MM-DD (optional) dateOfFirstShippingC/10 Kündigung zum Erstversanddatum YYYY-MM-DD Erstversanddatum (optional) messageNumberC/4Nummer der Nachricht, die ausgelöst werden soll (optional) calculatedToC/10 (optional) setTriggerOnlyBKündigung noch nicht sofort dürfen, sondern nur antriggern. (Default: false) Wenn es sich um eine Stornierung handelt (cancel=true), dann dürfen cancelNext, cancellationDate, issueNumber, publicationDate und dateOfFirstShipping nicht gesetzt sein. Wenn es keine Stornierung ist, muss genau eines dieser Felder gesetzt sein. Response Der Response ist eine JSON Struktur ElementBeschreibung expiryDateAblaufdatum expiryDescriptionBeschreibung des Fälligkeitsdatums messageZus. Meldung successtrue/false { "expiryDate": "", "expiryDescription": "", "message": "", "success" : "true" } Kündigung eines Abo rückgängig machen/ undoCancellation BETA Der Service ist grundsätzlich nur für die Stornierung der Kündigung von R-/ und L-Abos zu verwenden. Weitere Infos unter den bekannten Quellen im Wiki. Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/undoCancellation-1.0.0 Fuba: /DSB/_ISM_E_KUENDIGUNG_STORNO URL POST: /rest/{client}/subscriptions/{orderNumber}/undoCancellation?sp={sp}&so={so}… ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer orderNumber C/10Abonummer sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) Response Der Response ist eine JSON Struktur ElementBeschreibung messageZus. Meldung successtrue/false { "message": "", "success" : "true" } Kündigungs Infos Dieser Webservice bringt unterschiedliche Informationen zu einer Abokündigung zurück. Hinweis: Die Verwendung dieser Web-Services muss explizit mit dem Kundenberater abgestimmt werden und erfordert u.U. kundenspezifische Anpassungen. Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/getCancellationInfo-1.0.0 URL GET: /rest/{client}/subscriptions/{orderNumber}/cancellationInfo?sp={sp}&cancellationDate={cancellationDate} ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer orderNumber C/10Abo Nummer sp C/3Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)) cancellationDate D Gewünschter Kündigungstermin (YYYY-MM-DD) (opt.) cancellationReason C Kündigungsgrund (opt.) channel C Kanal (opt.) Response Der Response ist eine JSON Struktur ElementLängeTypText Hinweise oder Attributaufstellungen minRefIssueFollow 10C Mindestbezugsheftfolge VA: welches ist die letzte abzunehmende Heft-Folge Bsp .:„0000352857“ für Heft-Nr. 0005/2016 Druckerzeugnis 00000665 minRefIssueFollowNr 9 C Mindestbezugsheftfolge Heft-Nr.: welches ist die letzte abzunehmende Heft-Folge Bsp.: „0005/2016“ Druckerzeugnis 00000665 suggestedCancellationReason 3C Vorschlag Kündigungsgrund Bsp.: „301“ suggestedCancellationDate 10D Vorschlag Kündigungsdatum Bsp.: „2021-04-23“ (BETA) revocationDate10 D Widerrufsdatum: bis zu welchem Datum gilt eine Kündigung als Widerrufsfrist Bsp.: „2015-11-02“ revocationOrCancellationFlag1 C KZ ob Widerruf oder ob Kündigung endOfContractVa 10 C Vertragsende VABsp.: „0000352855“ für Heft-Nr. 0003/2016 Druckerzeugnis 00000665 endOfContractIssue 9C Vertragsende Heft-Nr.Bsp.:„0003/2016“ actualDeliveredIssues 2N Bis jetzt gelieferte FolgenBsp.: 15 calculatedIssues 2N Bis jetzt berechnete FolgenBsp.: 15 payedIssues 4N Bis jetzt bezahlte Folgen Bsp.: 15 contractAccountBalance7,2 N Aktueller Saldo des Vertragskontos negatives Vorzeichen = Kundenguthaben positives Vorzeichen = offene Forderungen vorhanden Bsp.:„1234567.89“ complaintAvailable B Gibt es aktuell Rekla-Einträge mit dem Wert <> „STGP“? true/false currentAddressSearch B Läuft aktuell eine Adress-Recherche für diesen Auftrag? true/false messageNumber 4C Nachrichten Nummer lastOsdMinRuntime 10 D Erstverkaufstag Mindestbezug „YYYY-MM-DD“ lastOsdActualPosition 10 D Erstverkaufstag aktuelle Position „YYYY-MM-DD„ lastOsdPayedTill 10 D (Erstverkaufstag bezahlt bis) „YYYY-MM-DD“ cancellable B Ist das Abo kündbar? true / false / leer/ nicht vorhanden = unknown info255C zus. Information details 0 … n cancelType 4C Kürzel zur Kündigungsart validTo 10D Lieferende / Kündigungsdatum calculatedTo 10D Berechnungsende ggf abw. zu Liefende deliveryEndReason 3C Kündigungsgrund description 100C Beschreibung zum Satz dateOfFirstSale 10D Erstverkaufstag „YYYY-MM-DD“ issue / payedTillIssue / calculatedToIssue / minTermIssue / existingCancellationIssue BETA issue 10C Vertriebsausgabe publication 8C Druckerzeugnis edition 8C Planvertriebsausgabe dateOfPublication 10C Erscheinungsdatum „YYYY-MM-DD“ plannedVariantType 2C Vertriebsausgabenvariantentyp - Standard (geplant) actualVariantType 2C Vertriebsausgabenvariantentyp - tatsächlich dateOfFirstShipping 10C Datum des ersten Versandtages „YYYY-MM-DD“ issueNumber 9C Heftnummer der Vertriebsausgabe yearOfIssue 4C Jahrgang der Ausgabe issueNumberInYear 4C Ausgabennummer (innerhalb des Jahrgangs) dateOfFirstSale 10C Erstverkaufstag „YYYY-MM-DD“ specialIssue C Kennzeichen Sonderausgabe) true/false doubleIssue 1C Doppelheft-Kennzeichen invoiceAttached C Merkmal diese Vertriebsausgabe mit Rechnungsbeilage true/false premiumAddressVariant C Premium-Adress-Variante für Pressepost true/false statisticalYearMonth C Statistikjahr, auch für Erlösverteilung verwendet + Statistikmonat mit Prüfung [1:12] description 50C VA Beschreibung { "minRefIssueFollow" : "", "minRefIssueFollowNr" : "", "suggestedCancellationReason" : "", "suggestedCancellationDate" : "", "revocationDate" : "", "revocationOrCancellationFlag" : "", "endOfContractVa" : "", "endOfContractIssue" : "", "actualDeliveredIssues" : "", "calculatedIssues" : "", "payedIssues" : "", "contractAccountBalance" : "", "complaintAvailable" : "", "currentAddressSearch" : "", "messageNumber" : "", "lastOsdMinRuntime" : "", "lastOsdActualPosition" : "", "lastOsdPayedTill" : "", "cancellable" : , "info" : "", "details" : [ { "cancelType" : "", "validTo" : "", "calculatedTo" : "", "deliveryEndReason" : "", "description" : "", "dateOfFirstSale" : "" }], "issue " : [ { "issue": "", "publication": "", "edition": "", "dateOfPublication": "", "yearOfIssue":, "issueNumberInYear": "", "issueNumber": "", "dateOfFirstSale": "", "description": "", "dateOfFirstShipping": "" "plannedVariantType" : "", "actualVariantType" : "", "specialIssue" : "", "doubleIssue" : "", "invoiceAttached" : "", "premiumAddressVariant" : "", "statisticalYearMonth" ; "" }], "payedTillIssue " : [ { "issue": "", "publication": "", "edition": "", "dateOfPublication": "", "yearOfIssue":, "issueNumberInYear": "", "issueNumber": "", "dateOfFirstSale": "", "description": "", "dateOfFirstShipping": "" "plannedVariantType" : "", "actualVariantType" : "", "specialIssue" : "", "doubleIssue" : "", "invoiceAttached" : "", "premiumAddressVariant" : "", "statisticalYearMonth" ; "" }], "calculatedToIssue " : [ { "issue": "", "publication": "", "edition": "", "dateOfPublication": "", "yearOfIssue":, "issueNumberInYear": "", "issueNumber": "", "dateOfFirstSale": "", "description": "", "dateOfFirstShipping": "" "plannedVariantType" : "", "actualVariantType" : "", "specialIssue" : "", "doubleIssue" : "", "invoiceAttached" : "", "premiumAddressVariant" : "", "statisticalYearMonth" ; "" }], "minTermIssue" : [ { "issue": "", "publication": "", "edition": "", "dateOfPublication": "", "yearOfIssue":, "issueNumberInYear": "", "issueNumber": "", "dateOfFirstSale": "", "description": "", "dateOfFirstShipping": "" "plannedVariantType" : "", "actualVariantType" : "", "specialIssue" : "", "doubleIssue" : "", "invoiceAttached" : "", "premiumAddressVariant" : "", "statisticalYearMonth" ; "" }], "existingCancellationIssue" : [ { "issue": "", "publication": "", "edition": "", "dateOfPublication": "", "yearOfIssue":, "issueNumberInYear": "", "issueNumber": "", "dateOfFirstSale": "", "description": "", "dateOfFirstShipping": "" "plannedVariantType" : "", "actualVariantType" : "", "specialIssue" : "", "doubleIssue" : "", "invoiceAttached" : "", "premiumAddressVariant" : "", "statisticalYearMonth" ; "" }] } Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. OK Weitere Information