GetCampaigns

Auslesen von Kampagneninformationen

Die Methode GetCampaigns ermöglicht es, Informationen über E-Mail Kampagnen aus mailworx auszulesen.

Request Properties

Type
Dient zur Filterung der Kampagnen anhand des Typs. Wird diese Eigenschaft nicht gesetzt, so werden alle Kampagnen ausgelesen.
Typ der Eigenschaft: Enumeration
Mögliche Werte:

  • InWork = 1
    Filterung auf Kampagnen, die in Arbeit sind
  • Sent = 2
    Filterung auf Kampagnen, die bereits versendet wurden
  • EventDependent = 4
    Filterung auf Kampagnen, die ereignisabhängig sind

Id
Dient zum Auslesen einer einzelnen Kampagne, indem die GUID der Kampagne übergeben wird.
Typ der Eigenschaft: GUID

FromCreated
Dient zur Filterung auf Kampagnen, die seit dem übergebenen Datum erstellt wurden.
Typ der Eigenschaft: Datum

ToCreated
Dient zur Filterung auf Kampagnen, die bis zu dem übergebenen Datum erstellt wurden.
Typ der Eigenschaft: Datum

LastChange
Dient zur Filterung auf Kampagnen, die seit dem übergebenen Datum geändert wurden.
Typ der Eigenschaft: Datum

FromSent
Dient zur Filterung auf Kampagnen, die seit dem übergebenen Datum versendet wurden.
Typ der Eigenschaft: Datum

ToSent
Dient zur Filterung auf Kampagnen, die bis zu dem übergebenen Datum versendet wurden.
Typ der Eigenschaft: Datum

ResponseDetail
Hiermit können Sie steuern, wie detailliert die Informationen sein sollen, die von mailworx zurückgegeben werden. Wird diese Eigenschaft nicht gesetzt, so werden die Basisinformationen (BasicInformation = 1) ausgelesen.
Typ der Eigenschaft: Enumeration
Mögliche Werte:

  • BasicInformation = 1
    Liefert die Basisinformationen der Kampagne
  • Sections = 2
    Liefert die Abschnitte der jeweiligen Kampagne mit deren Werten
  • Links = 4
    Liefert alle statischen Links der Kampagne
    Wird für diese Eigenschaft sowohl Sections als auch Links gesetzt, so werden auch die Links der Abschnitte geliefert.
  • SectionProfiles = 8
    Liefert die Einschränkung der Abschnitte auf Abonnentengruppen
Beispiel Request "Alle Kampagnen auslesen"

Der folgende Request liefert alle verfügbaren Kampagnen des Mandanten "account".

JSON
//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/GetCampaigns
{
	"request":
	{
		"SecurityContext":
		{
			"Account":"account",
			"Username":"username",
			"Password":"*****",
			"Source":"application name"
		},
		"Language":"DE"
	}
}
XML
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="https://sys.mailworx.info/Services/ServiceAgent.asmx"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soap:Header/>
	<soap:Body>
		<ser:GetCampaigns>
			<ser:request>
				<ser:Language>DE</ser:Language>
				<ser:SecurityContext>
					<ser:Account>account</ser:Account>
					<ser:Username>username</ser:Username>
					<ser:Password>*****</ser:Password>
					<ser:Source>application name</ser:Source>
				</ser:SecurityContext>
			</ser:request>
		</ser:GetCampaigns>
	</soap:Body>
</soap:Envelope>
Beispiel Request "Detailinformationen aller Kampagnen die in einem bestimmten Zeitraum erstellt wurden"

Der folgende Request liefert alle verfügbaren Kampagnen des Mandanten "account", die folgende Kriterien erfüllen:

  • Kampagne ist vom Typ "in Arbeit"
  • Kampagne wurde zwischen 01.06.2016 und 02.06.2016 erstellt
  • Ausgabe der Links der Kampagne sowie der Basisinformationen
JSON
//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/GetCampaigns
{
	"request":
	{
		"SecurityContext":
		{
			"Account":"account",
			"Username":"username",
			"Password":"*****",
			"Source":"api name"
		},
		"Language":"DE",
		"Type":"1",
		"FromCreated":"/Date(1464773077000+0200)/",
		"ToCreated":"/Date(1464859477000+0200)/",
		"ResponseDetail":"5"
	}
}
XML
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="https://sys.mailworx.info/Services/ServiceAgent.asmx"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soap:Header/>
	<soap:Body>
		<ser:GetCampaigns>
			<ser:request>
				<ser:Language>DE</ser:Language>
				<ser:SecurityContext>
					<ser:Account>account</ser:Account>
					<ser:Username>username</ser:Username>
					<ser:Password>*****</ser:Password>
					<ser:Source>api name</ser:Source>
				</ser:SecurityContext>
				<ser:Type>InWork</ser:Type>
	            <ser:FromCreated>2016-06-02T00:00:00.0</ser:FromCreated>
	            <ser:ToCreated>2016-06-01T00:00:00.0</ser:ToCreated>
	            <ser:ResponseDetail>BasicInformation Links</ser:ResponseDetail>
			</ser:request>
		</ser:GetCampaigns>
	</soap:Body>
</soap:Envelope>

Response Objekt

Name
Name der Kampagne

Culture
Sprache der Kampagne

SenderName
Absendername der Kampagne

SenderAddress
Absenderadresse der Kampagne

Subject
Betreff der Kampagne

ProfileName
Name der Abonnentengruppe, an die diese Kampagne gesendet wird/wurde

ProfileGuid
ID der Abonnentengruppe an die diese Kampagne gesendet wird/wurde

TemplateName
Name der Vorlage/des Layouts, die/das für diese Kampagne verwendet wird/wurde

TemplateGuid
ID der Vorlage/des Layouts, die/das für diese Kampagne verwendet wird/wurde

NotifyAddress
Jene E-Mail Adresse, an die eine Notify Nachricht geschickt wird, wenn ein Abonnent seine Daten ändert, die Kampagne weiterleitet oder sich abmeldet.

Created
Zeitpunkt, an dem diese Kampagne erstellt wurde

User
Vollständiger Name des Benutzers, der diese Kampagne erstellt hat

UserGuid
ID des Benutzers, der diese Kampagne erstellt hat

WorkflowState
Status der Bearbeitung der Kampagne (InWork, ReadyToCheck, ReadyToSend, Archive)

ShowTableOfContents
Wird das Inhaltsverzeichnis der Kampagne angezeigt? (Nein = 0, Ja = 1)

ShowChangeData
Ist es dem Abonnenten möglich, seine Daten zu ändern? (Nein = 0, Ja = 1)

ShowForward
Ist es dem Abonnenten möglich, die Kampagne über mailworx weiterzuleiten? (Nein = 0, Ja = 1)

ShowUnsubscribe
Ist es dem Abonnenten möglich, sich von der Kampagne abzumelden? (Nein = 0, Ja = 1)

AllowCopy
Ist es erlaubt, eine Kopie dieser Kampagne zu erstellen? (Nein = 0, Ja = 1)

SendType
Versandart der Kampagne (Manuell = 0, Ereignisabhängig = 1, A/B Split Test = 2)

LastSentTime
Zeitpunkt, an dem diese Kampagne das letzte Mal versendet wurde. Ist dieser Wert nicht gegeben, wurde diese Kampagne noch nie versendet.

CampaignLinks
Eine Liste aller statischen Links, welche in dieser Kampagne vorkommen.
Hinweis: Diese Liste wird nur dann befüllt, wenn die Eigenschaft ResponseDetail im Request Objekt auf Links gesetzt wurde.

Sections
Eine Liste aller in dieser Kampagne vorhandenen Abschnitte.
Hinweis: Diese Liste wird nur dann befüllt, wenn die Eigenschaft ResponseDetail im Request Objekt auf Sections gesetzt wurde.
Jeder Abschnitt in dieser Liste beinhaltet seine ID , seinen Namen für die Statistik und seinen Erstellungszeitpunkt.
Hinweise:

  • Ist im Request Objekt die Eigenschaft ResponseDetail auf BasicInformation gesetzt, so wird für jeden Abschnitt zusätzlich noch der Name des Abschnittstyps ausgelesen.
  • Ist im Request Objekt die Eigenschaft ResponseDetail auf SectionProfiles gesetzt, werden für jeden Abschnitt zusätzlich noch die Abonnentengruppen ausgelesen, auf die dieser Abschnitt eingeschränkt ist.
  • Ist im Request Objekt die Eigenschaft ResponseDetail auf Links gesetzt, so werden für jeden Abschnitt zusätzlich noch alle enthaltenen Links geladen.