Hilfe-Center
  1. Startseite
  2. Technische Referenz
  3. API
  4. API-Funktionen
  5. Newsletters

Newsletters

Beinhaltet Funktionen zum Arbeiten mit dem Newslettersystem Newsletter2Go.

Reset()

Alle bekannten Newsletter Daten werden zurückgesetzt.
Bei der nächsten Anfrage danach werden diese wieder aus der API nachgeladen.

Copy

API.Newsletters.Reset()

IsEnabled As Boolean

Gibt zurück ob Newsletter2Go aktiviert ist.

Copy

API.Newsletters.IsEnabled

IsReachable As Boolean

Gibt zurück ob der Diensrt von Newsletter2Go erreichbar ist.

Copy

API.Newsletters.IsReachable

Forms() As IEnumerable(Of iNewsletterForm) [V2]

Gibt eine Liste der zur Verfügung stehenden Formulare wie zum Beispiel das Anmeldeformular zurück.

Copy

API.Newsletters.Forms()

GetFormById(FormId As String) As iNewsletterForm

Liefert ein bestimmtes Formular anhand der ID.

Copy

API.Newsletters.GetFormById("kjl6sdf4")

GetMailingById(MailingId As String) As iNewsletterMailing

Liefert eine bestimmte Nachricht anhand der ID.

Copy

API.Newsletters.GetMailingById("pjl6sdf2")

SetFormIdForShapeAttribute(
    FormId As String,
    TxtAttr As iTypedText,
    Modifier As iPerson
) As Boolean

Prüft ob die FormularID gültig ist und spiechert diese dann in das zugehörige AttributeValue.

  • FormId: Die ID des Furmulars, welche von Newsletter2Go kommt
  • TxtAttr: Das Text-Attribut in dem die ID gespeichert werden soll
  • Modifier: Objekt der Person, die den Eintrag erstellt
Copy

Newsletters.SetFormIdForShapeAttribute(SelectedFormId, TheFormAttr, Administrator)

SetMailingIdForShapeAttribute(
    FormId As String,
    MailingId As String,
    TxtAttr As iTypedText,
    Modifier As iPerson
) As Boolean

Prüft ob die FormularID und die MailingID gültig sind und spiechert die MailingID dann in das zugehörige AttributeValue.

  • FormId: Die ID des Furmulars, welche von Newsletter2Go kommt
  • MailingId: Die ID der Nachricht, welche von Newsletter2Go kommt
  • TxtAttr: Das Text-Attribut in dem die ID gespeichert werden soll
  • Modifier: Objekt der Person, die den Eintrag erstellt
Copy

Newsletters.SetMailingIdForShapeAttribute(SelectedFormId, SelectedMailingId, TheProfileMailAttr, Administrator)

ParseActionLinkQuery(
    QueryString As Specialized.NameValueCollection,
    Optional ParamKey As String = "n2g"
) As Tuple(Of iNewsletterForm, iNewsletterRecipient)

Liest die relevanten Informationen aus der URL aus, wenn diese vom Newsletter direkt kommen, wie zum Beispiel der Link zum abbestellen des Newsletters. Die URL kann wie folgt aussehen https://procomp.de/newsletter?n2g=wk6twr13-ybg3nbs3-velw5jhu-qyh

  • QueryString: Die Collection aller QueryString der URL, also "?n2g=wk6twr13-ybg3nbs3-velw5jhu-qyh"
  • Optionale Parameter
    • ParamKey: Der Key, dessen Value die relevanten Informationen enthält, der Standardwert ist "n2g"
Copy

API.Newsletters.ParseActionLinkQuery(Request.QueryString)

War dieser Beitrag hilfreich?
10 von 10 fanden dies hilfreich.
Schade! Bitte teilen Sie uns doch mit was Ihnen nicht weitergeholfen hat.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.