10. Dezember 2021

· Whitepaper

SubscriberMultiChange

Inhaltsverzeichnis

xx Kapitel

Massenänderung

Die Methode SubscriberMultiChange ermöglicht es, eine Massenänderung an den Daten aller Empfänger oder an den Empfängern einer bestimmten Zielgruppe durchzuführen.

Request Properties

SearchExpression
Der Suchausdruck, nach dem gesucht werden soll.
Sollen Werte in Auswahl- oder Mehrfachauswahlfeldern geändert werden, so muss die SearchExpression die Werte mit „;“ getrennt beinhalten.
Typ der Eigenschaft: STRING

ReplaceExpression
Der Ersetzungsausdruck mit den neuen Daten.
Typ der Eigenschaft: STRING

MatchSettings
Sollen Werte in Auswahl- oder Mehrfachauswahlfeldern geändert werden, so muss MatchSettings verwendet werden, um zu steuern, wie genau nach den Werten gesucht werden soll.
MatchSettings greift nur, wenn beim FieldName ein Feld vom Typ Auswahl oder Mehrfachauswahl angegeben wurde. Wird MatchSettings gesetzt, obwohl ein Feld von einem anderen Typ angegeben wurde, so greifen die Einstellungen nicht.
Typ der Eigenschaft: MatchingOption

FieldName
Der interne Name des Empfängerfelds, dessen Werte geändert werden sollen.
Typ der Eigenschaft: STRING

ProfileId
Die ID der Zielgruppe, für deren Empfänger die Werte geändert werden sollen. Wird dieser Wert nicht gesetzt, so werden alle Empfänger des Mandanten geändert.
Typ der Eigenschaft: GUID

Beispiel Request „SubscriberMultichange“

Der folgende Request ändert von allen Empfängern der definierten Zielgruppe den Wert des Empfängerfeldes mit dem internen Namen „company“ von „eworx“ zu „mailworx“.
Als Response wird die Anzahl der geänderten Empfänger geliefert.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/SubscriberMultiChange
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "*****",
      "Source": "application name"
    },
    "MatchSettings": 0,
    "ProfileId": "1ad0e7b2-83d2-4631-af34-f7ace5a78924",
    "FieldName": "company",
    "SearchExpression": "eworx",
    "ReplaceExpression": "mailworx"
  }
}

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:SubscriberMultiChange>
      <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:MatchSettings>Exact</ser:MatchSettings>
        <ser:ProfileId>1ad0e7b2-83d2-4631-af34-f7ace5a78924</ser:ProfileId>
        <ser:FieldName>company</ser:FieldName>
        <ser:SearchExpression>eworx</ser:SearchExpression>
        <ser:ReplaceExpression>mailworx</ser:ReplaceExpression>     
      </ser:request>
    </ser:SubscriberMultiChange>
  </soap:Body>
 </soap:Envelope>

Response Objekt

Amount
Die Anzahl der Empfänger, bei denen der Wert des Empfängerfeldes geändert wurde.
Typ der Eigenschaft: INT