10. Dezember 2021

· Whitepaper

ExportSubscribers

Inhaltsverzeichnis

xx Kapitel

Exportieren von Empfängern

Die Methode ExportSubscribers ermöglicht es, Empfänger aus der eworx Marketing Suite zu exportieren.

Request Properties

ProfileGuid
Die Id der Zielgruppe von der die Empfänger ausgelesen werden sollen.
Typ der Eigenschaft: GUID

LastChange
Es werden nur jene Empfänger ausgelesen, die zuletzt nach dem angegebenen Datum geändert wurden.
Typ der Eigenschaft: DATETIME

Conditions
Die Bedingungen, die von den Empfängern erfüllt sein müssen, damit diese ausgelesen werden. Werden mehrere Bedingungen angegeben, so werden diese mit UND verknüpft.
Typ der Eigenschaft: Array von Condition

SubscriberIds
Eine Liste jener Empfänger-Ids, deren zugehörige Empfänger ausgelesen werden sollen.
Typ der Eigenschaft: Array von GUIDs

Fields
Eine Liste von Empfängerfeldern, die ausgelesen werden sollen.
Typ der Eigenschaft: Array von Field

Beispiel Request „Exportieren von Empfängern“

Der folgende Request gibt alle Empfänger der angegebenen Empfängergruppe aus die zusätzlich auch den Nachnamen „Mustermann“ haben. Zusätzlich wird für jeden Empfänger das Empfängerfeld mit dem internen Namen „firstname“ ausgelesen.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/ExportSubscribers
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "*****",
      "Source": "application name"
    },
    "ProfileGuid": "1ad0e7b2-83d2-4631-af34-f7ace5a78924",
    "Conditions":[
      {
        "Field":{
          "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
          "InternalName": "lastname"
        },
        "Operator":0,
        "Value":"Mustermann"
      }
    ],
    "Fields": [
      {
        "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
        "InternalName": "firstname"
      }
    ]
  }
}

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:ExportSubscribers>
      <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:ProfileGuid>1ad0e7b2-83d2-4631-af34-f7ace5a78924</ser:ProfileGuid>
        <ser:Conditions>
		  <ser:Condition>
            <ser:Field  xsi:type="ser:TextField">
              <ser:InternalName>lastname</ser:InternalName>
            </ser:Field>
            <ser:Operator>Equals</ser:Operator>
            <ser:Value xsi:type="xsd:string">Mustermann</ser:Value>
          </ser:Condition>
        </ser:Conditions>
        <ser:Fields>
          <ser:Field  xsi:type="ser:TextField">
            <ser:InternalName>firstname</ser:InternalName>
          </ser:Field>
        </ser:Fields>
      </ser:request>
    </ser:ExportSubscribers>
  </soap:Body>
 </soap:Envelope>

Response Objekt

Subscribers
Eine Liste von Empfängern mit ihren Metadaten und den Empfängerfeldwerten, die über den Request-Parameter Fields zum Auslesen deklariert wurden.
Typ der Eigenschaft: Array von Subscriber