10. Dezember 2021

· Whitepaper

GetCampaigns

Inhaltsverzeichnis

xx Kapitel

Kampagneninformationen auslesen

Die Methode GetCampaign ermöglicht es, mailworx E-Mail Kampagnen aus der eworx Marketing Suite auszulesen.

Request Properties

FromCreated

Datum nach dem die Kampagne erstellt worden sein muss damit sie ausgelesen wird. Wird dieses Datum nicht gesetzt wird dieses Ausschlusskriteirum ignoriert.
Typ der Eigenschaft: DATE

From Sent

Datum nachdem die Kampagne versendet worden musste damit sie ausgelesen wird. Wird dieses Datum nicht gesetzt wird dieses Ausschlusskriterium ignoriert.
Typ der Eigenschaft: DATE

Id

Die Id der Kampagne die ausgelesen werden soll. Wird keine Id definiert wird dieses Ausschlusskriterium ignoriert.
Typ der Eigenschaft: GUID

LastChange

Das Datum nachdem die Kampagne bearbeitet werden musste damit sie ausgelesen wird. Wird kein Datum definiert wird dieses Ausschlusskriterium ignoriert.
Typ der Eigenschaft: DATE

ResponseDetail

Der Detailgrad wie viele Informationen zu den Kampagnen ausgelesen werden sollen.
Typ der Eigenschaft: CampaignResponseDetailInfo

ToCreated

Datum vor dem die Kampagne erstellt worden sein muss damit sie ausgelesen wird. Wird dieses Datum nicht gesetzt wird dieses Ausschlusskriteirum ignoriert.
Typ der Eigenschaft: DATE

ToSend

Datum vor dem die Kampagne versendet worden musste damit sie ausgelesen wird. Wird dieses Datum nicht gesetzt wird dieses Ausschlusskriteirum ignoriert.
Typ der Eigenschaft: DATE

Type

Der Kampagnentyp der ausgelesen werden soll. Wird kein Typ definiert wird dieses Ausschlusskriterium nicht berücksichtigt.
Typ der Eigenschaft: CampaignType

Beispiel Request „Kampagneninformationen auslesen“

Auslesen aller versendeten Kampagnen die nach dem 01.01.2019 erstellt wurde und nach dem 01.06.2019 bearbeitet wurden.
Außerdem muss die Kampagne vor dem 01.06.2020 versendet worden sein.
Ausgelesen werden die Basisinformationen und die Links der Kampagne.

JSON

{
  "request": {
    "Language": "DE",
   	"SecurityContext": {
			"Account": "account",
			"Username": "username",
			"Password": "*****",
			"Source": "application name"
	},
	"ResponseDetail": 5,
	"Type": 2,
	"FromCreated": "\/Date(1559340000000)\/",
	"LastChange": "\/Date(1559340000000)\/",
	"ToSent": "\/Date(1590962400000)\/"
  }
}

XML

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:ser="http://www.mailworx.at/interfaces/serviceagent/"  
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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:ResponseDetail>BasicInformation Links</ser:ResponseDetail>
        <ser:Type>Sent</ser:Type>
        <ser:FromCreated>2019-01-01T00:00:00</ser:FromCreated>
        <ser:LastChange>2019-06-01T00:00:00</ser:LastChange>
        <ser:ToSent>2020-06-01T00:00:00</ser:ToSent>
      </ser:request>
    </ser:GetCampaigns>
  </soap:Body>
 </soap:Envelope>

Response Objekt

Campaigns

Eine Liste von Kampagnen-Objekten.
Typ der Eigenschaft: Campaign