10. Dezember 2021

· Whitepaper

ExportSubscribersWithFormFields

Inhaltsverzeichnis

xx Kapitel

Empfänger mit Formularfeldern exportieren

Die Methode ExportSubscribersWithFormFields ermöglicht es, eine Liste von Empfängern mit ihren Empfängerfeldern und zusätzlich mit all ihren Eingaben, die diese Empfänger in bestimmten Formularen gemacht haben, auszulesen.

Request Properties

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

LastChange
Es werden nur jene Empfänger ausgelesen, die nach diesem 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.
Typ der Eigenschaft: Condition

SubscriberIds
Eine Liste jener Empfänger-IDs, die 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

FormGuids
Eine Liste jener Formular-IDs von denen die Formularfelder ausgegeben werden sollen.
Typ der Eigenschaft: Array von GUIDs

Beispiel Request „Empfänger mit Formularfeldern auslesen“

Der folgende Request gibt alle Empfänger der angegebenen Zielgruppe mit ihren Metafeldern aus. Zusätzlich wird für jeden Empfänger das Empfängerfeld mit dem internen Namen „firstname“ ausgelesen. Außerdem werden für das angegebene Formular alle Formularfeldwerte geliefert.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/ExportSubscribersWithFormFields
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "*****",
      "Source": "application name"
    },
    "ProfileGuid": "94175568-4ad0-400d-8a69-6f994675ecee",
    "Fields": [
      {
        "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
        "InternalName": "firstname"
      }
    ],
    "FormGuids": ["6cf5fc55-2270-4251-8435-d1388ef6f246"]
  }
}

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">
  <soap:Header/>
  <soap:Body>
    <ser:ExportSubscribersWithFormFields>
      <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>94175568-4ad0-400d-8a69-6f994675ecee</ser:ProfileGuid>
        <ser:Fields>
          <ser:Field xsi:type="ser:TextField">
            <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
            <ser:InternalName>firstname</ser:InternalName>
          </ser:Field>
        </ser:Fields>
        <ser:FormGuids>
          <ser:Guid>6cf5fc55-2270-4251-8435-d1388ef6f246</ser:Guid>
        </ser:FormGuids>
      </ser:request>
    </ser:ExportSubscribersWithFormFields>
  </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.

FormFieldValues
Eine Liste mit den Informationen darüber, welche Eingaben die Empfänger in den Formularen gemacht haben.
Für jedes Formular werden folgende Daten ausgelesen:

  • Die ID des Formulars.
  • Eine Liste von Formularfeld-Namen, die in diesem Formular vorkommen.
  • Eine Liste von den Empfängern, die dieses Formular ausgefüllt haben, und dazu alle Werte der Formularfelder.