GetForms

Formulare auslesen

Die Methode GetForms ermöglicht es, die Formulare eines Mandanten anhand von Suchkriterien auszulesen.

Request Properties

FormId
Die eindeutige ID des Formulars, das ausgelesen werden soll.
Typ der Eigenschaft: GUID
Optional

FormType
Der Typ der Formulare, die ausgelesen werden sollen. Mögliche Werte: 0 (Normal), 1 (Event).
Typ der Eigenschaft: FormType
Optional

Name
Der Name der Formulare, die ausgelesen werden sollen. Der Suchbegriff wird bei Leerzeichen getrennt, ein Formular wird nur dann gefunden, wenn sein Name alle Teilbegriffe enthält.
Typ der Eigenschaft: STRING
Optional

FormLanguage
Die Sprache der Formulare im ISO-Code, z.B. "DE". Ist die Sprache im Mandanten nicht verfügbar, wird ein Fehler zurückgegeben.
Typ der Eigenschaft: STRING
Optional

NotifyRecipientName
Der Name eines Empfängers der Benachrichtigung des Formulars. Der Suchbegriff wird wie bei Name ausgewertet.
Typ der Eigenschaft: STRING
Optional

NotifyRecipientAddress
Die E-Mail Adresse eines Empfängers der Benachrichtigung des Formulars. Der Suchbegriff wird wie bei Name ausgewertet.
Typ der Eigenschaft: STRING
Optional

Alle Suchkriterien sind für sich optional, es muss jedoch mindestens eines gesetzt sein. Werden mehrere Kriterien angegeben, so werden diese UND-verknüpft.

Beispiel Request „Formulare auslesen“

Der folgende Request liest alle normalen Formulare des Mandanten aus, deren Name die Begriffe "Kontakt" und "Newsletter" enthält und die in der Sprache Deutsch angelegt sind.

//https://mailworx.marketingsuite.info/Services/JSON/ServiceAgent.svc/GetForms
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "****",
      "Source": "application name"
    },
    "FormType": 0,
    "Name": "Kontakt Newsletter",
    "FormLanguage": "DE"
  }
}

<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:GetForms>
      <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:FormType>Normal</ser:FormType>
        <ser:Name>Kontakt Newsletter</ser:Name>
        <ser:FormLanguage>DE</ser:FormLanguage>
      </ser:request>
    </ser:GetForms>
  </soap:Body>
</soap:Envelope>

Response Objekt

Forms
Die Formulare, die den Suchkriterien entsprechen, aufsteigend nach Name sortiert.
Typ der Eigenschaft: Liste von Form