SubmitForm

Absenden eines Formulars

Die Methode SubmitForm ermöglicht das Absenden eines Formulars über die Schnittstelle. Es werden alle Konfigurationen des Formulars berücksichtigt und alle Aktionen entsprechend ausgeführt. Außerdem werden alle Validierungen, wie bei einer normalen Formularabsendung, durchgeführt.

Handelt es sich um ein Eventformular wird durch die Absendung auch die Event-Anmeldung durchgeführt.

Request Properties

FormId
Die ID des Formulars, das abgesendet werden soll.
Typ der Eigenschaft: GUID

SubscriberId
Die ID des Empfängers, dem die Daten der Formularabsendung zugewiesen werden sollen. Wird keine SubscriberId angegeben, wird die Duplikats-Prüfung anhand der Formularkonfiguration durchgeführt.
Typ der Eigenschaft: GUID

FormSubmitFields
Die Liste an Formularfelder, die als Daten für das abzusendendes Formular verwendet werden. Für Empfängerfelder im Formular kann über GetSubscriberFields der interne Name ermittelt werden.
Typ der Eigenschaft: List von FormSubmitField

Beispiel Request „Formular absenden“

Der folgende Request sendet ein Formular ab, in dem sowohl Formularfelder als auch Empfängerfelder vorkommen. Durch das angeben der SubscriberId, wird genau dieser Empfänger bearbeitet.

JSON

//https://mailworx.marketingsuite.info/Services/JSON/ServiceAgent.svc/SubmitForm
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "*****",
      "Source": "application name"
    },
    "FormId": "5289f2e1-ea6b-4a9a-954d-fe3d7789dfe9",
    "SubscriberId": "b22925b4-4562-f011-899c-047bcbb9ede3",
    "FormSubmitFields": [
      {
        "InternalName": "email",
        "Value": "[email protected]"
      },
      {
        "InternalName": "firstname",
        "Value": "Service"
      },
      {
        "InternalName": "mxCFF_text",
        "Value": "Textfeld Wert"
      }
    ]
  }
}

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:SubmitForm>
      <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:FormId>5289f2e1-ea6b-4a9a-954d-fe3d7789dfe9</ser:CampaignId>
        <ser:SubscriberId>b22925b4-4562-f011-899c-047bcbb9ede3</ser:CampaignId>
        <ser:FormSubmitFields>
          <ser:FormSubmitField>
            <ser:InternalName>email</ser:SubscriberId>
            <ser:Value>[email protected]</ser:SubscriberId>
          </ser:FormSubmitField>
          <ser:FormSubmitField>		
            <ser:InternalName>firstname</ser:SubscriberId>
            <ser:Value>Service</ser:SubscriberId>
          </ser:FormSubmitField>
          <ser:FormSubmitField>		
            <ser:InternalName>mxCFF_text</ser:SubscriberId>
            <ser:Value>Textfeld Wert</ser:SubscriberId>
          </ser:FormSubmitField>
        </ser:FormSubmitFields>
      </ser:request>
    </ser:SubmitForm>
  </soap:Body>
</soap:Envelope>

Response Objekt

Success
Gibt an, ob das Absenden des Formulars erfolgreich war.
Typ der Eigenschaft: BOOL

GuestState
Wenn das verwendete Formular ein Eventformular ist und ein Event damit verknüpft ist, wird im GuestState der neue Status des Gastes in dem Event angegeben.
Typ der Eigenschaft: STRING

ErrorCode
Gibt an welches Problem im Fehlerfall aufgetreten ist.
Typ der Eigenschaft: STRING
Folgende Fehler können auftreten. Mehrere Fehler werden mit "|" konkateniert. [Displayname] ist ein Platzhalter für die Bezeichnung des Feldes im Formular (z.b. Email_PLEASE_INSERT_A_VALUE).

Allgemein
- Unknown_Error
- Analysis_Disabled
- BooleanFormatError
- SqlException
- _FORM_IS_INACTIVE
- EMAILFIELD_WRONGFORMAT
- X_SUBSCRIBER_OR_FORMID_MISSING
- X_SUBSCRIBER_UPDATED_MAIL_SEND_ERROR

Spam
- X_SPAM_BLACKLIST
- X_SPAM_CAPTCHA
- X_SPAM_PHRASE
- X_SPAM_TIME_VALUES
- X_SPAM_TIME_EXEEDED

Feldspezifisch
- [Displayname]_AT_LEAST_ONE_VALUE_MUST_BE_SELECTED
- [Displayname]_PLEASE_INSERT_A_VALUE
- [Displayname]_IS_NOT_A_NUMBER
- [Displayname]_VALUE_IS_TO_BIG_OR_TO_SMALL
- [Displayname]_IS_NOT_A_DATE_VALUE
- [Displayname]_VALUE_IS_TO_LONG_OR_TO_SHORT
- [Displayname]_GUESTQUOTA_ERROR
- [Displayname]_QUOTA_EXCEEDED