Auslesen von Kampagneninformationen – GetCampaigns

Beim Importieren von Abonnenten über die mailworx Web-Service Schnittstelle, ist es möglich, dass nach dem Import allen Abonnenten automatisch eine Newsletter-Kampagne gesendet wird. Hierzu ist es notwendig, die benötigte Kampagneninformationen der Methode zur Verfügung zu stellen. Die Kampagneninformation können mittels GetCampaigns ausgelesen werden.

In mailworx existieren zwei Arten von Kampagnen: Ereignisabhängige Kampagnen, welche beim Eintreten eines bestimmten Ereignisses, wie z.B.: das Ausfüllen eines Formulars, oder bei Geburtstagsmails das eintreten des bestimmten Datums, an den/die entsprechenden Abonnenten gesendet wird und Standardkampagnen, welche manuell versendet werden.

Die Methode GetCampaigns ermöglicht das separate auslesen von ereignisabhängigen und bereits versendete Standardkampagnen, sowie Standardkampagnen, welche noch nicht versendet wurden. (Eigenschaft Type).

Des Weiteren ermöglicht die Schnittstelle das Auslesen der Kampagneninformationen in verschiedenen Detailtiefen:
CampaignResponseDetailInfo.BasicInformation: Liest lediglich die Basisinformationen der Kampagnen:

Name: Name der Kampagne
NotifyAddress: An diese Adresse wird eine Notify Nachricht geschickt, wenn ein Abonnent seine Daten ändert, den Newsletter weiterleitet, oder sich vom Newsletter abmeldet.
ProfileGuid: An welche Abonnentengruppe wird/wurde die Kampagne gesendet
SenderAddress: Absenderadresse des Newsletters
SenderName: Absendername des Newsletters
ShowChangeData: Ist es dem Abonnenten möglich, seine Daten zu ändern
ShowForward: Ist es dem Abonnenten möglich, den Newsletter per mailworx weiterzuleiten
ShowTableOfContents: Wird das Inhaltsverzeichnis des Newsletters angezeigt.
ShowUnsubscribe: Ist es dem Abonnenten möglich, sich vom Newsletter abzumelden.
UserGuid: Die ID des Benutzers, der diese Kampagne erstellt hat.
Created: Der Zeitpunkt, an dem diese Kampagne erstellt wurde.
AllowCopy: Ist es erlaubt, eine Kopie dieser Kampagne zu erstellen.
Subject: Der Betreff des Newsletters.
SendType: Die Versandart des Newsletters (Manuell oder Ereignisabhängig)
User: Der Vollständige Name des Benutzers, der diese Kampagne erstellt hat.
ProfileName: Der Name der Abonnentengruppe, an dem diese Kampagne gesendet wird/wurde.
TemplateName: Der Name der Newslettervorlage, die für diese Kampagne verwendet wird/wurde.

CampaignResponseDetailInfo.Links:

CampaignLinks: Beinhaltet alle statischen Links, welche in dieser Kampagne vorkommen.

CampaignResponseDetailInfo.Sections:

Sections: Beinhaltet alle in dieser Kampagne vorhandenen Abschnitte.
Jede Section beinhaltet die ID des Abschnittes, den Namen für die Statistik und den Erstellungszeitpunkt.

Ist zusätzlich CampaignResponseDetailInfo.BasicInformation gesetzt, wird auch noch der Name des Abschnittstyps mit ausgelesen.
Ist zusätzlich CampaignResponseDetailInfo.SectionProfiles gesetzt, werden auch noch die Abonnentengruppe mit ausgelesen, welchen ein Abonnent entsprechen muss, damit der Abonnent diesen Abschnitt im Newsletter bekommt.
Ist zusätzlich CampaignResponseDetailInfo.Links gesetzt, so werden auch noch sämtliche Informationen von der in den Abschnitten enthaltenen Links geladen.
Für den Aufruf werden also folgende Klassen benötigt:

Das Request Objekt beinhaltet also die Informationen welche Kampagnen ausgelesen werden sollen und in welche Detailtiefe.
Das Response Objekt beinhaltet die entsprechenden Kampagnen im entsprechenden Detailgrad.