Tech Docs
API Dokumentation
Einleitung
API Objekte/Strukturen
API Methoden
Codebeispiele
Anmeldeformular
Link-/Formular-URL
Newsletter-Archiv in XML
E-Mail Support
FAQ

In diesem Kapitel werden die vom Webdienst bereitgestellten Objekte und Strukturen beschrieben.

Account

Das Objekt Account enthält die Account Informationen.

Attribute

Hier ist eine Liste der Attribute des Account Objekts. Wenn nicht speziell angegeben, sind alle Felder Pflichtfelder.

ACC_UUIDDie interne eindeutige Account-UUID des Accounts.
ACC_NAMEDer Name des Accounts.
ACC_CUST_UUIDDie interne Kunden-UUID des Accounts.
ACC_CUST_NAMEDer Name des Kunden.
ACC_SHORTDas Kürzel des Accounts
ACC_SUBSCT_CODEDer konfigurierte Abonnententyp des Accounts (z.B. MSUBSC, SUBSC und ESUBSC)
ACC_ENT_UUIDDie interne Entitäts-UUID des Accounts.

SOAP 1.1

Der folgende Code zeigt die XML-Darstellung für ein Account-Objekt.

  1. <a:Account>
  2.     <a:ACC_CUST_NAME>Testkunde</a:ACC_CUST_NAME>
  3.     <a:ACC_CUST_UUID>XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX</a:ACC_CUST_UUID>
  4.     <a:ACC_ENT_UUID>XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX</a:ACC_ENT_UUID>
  5.     <a:ACC_NAME>Testaccount</a:ACC_NAME>
  6.     <a:ACC_SHORT>test</a:ACC_SHORT>
  7.     <a:ACC_SUBSCT_CODE>ESUBSC</a:ACC_SUBSCT_CODE>
  8.     <a:ACC_UUID>XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX</a:ACC_UUID>
  9. </a:Account>

Subscriber

Das Objekt Subscriber enthält alle Informationen (E-Mail, Vorname, Nachname, usw.) eines Abonnenten.

Attribute

Die folgende Liste zeigt alle Attribute des Subscriber-Objekts, geordnet nach Pflicht- und optionalen Feldern.

Mandatory:

SUBSC_UUIDDie interne Subscriber-UUID.
SUBSC_ACC_UUIDDie interne Account-UUID des Abonnenten.
SUBSC_FIRSTNAMEDer Vorname des Abonnenten.
SUBSC_LASTNAMEDer Nachname des Abonnenten.
SUBSC_GNDT_CODEGeschlechtscode des Abonnenten
(„M“ = Männlich, „F“ = Weiblich, „-“ = n/a).
SUBSC_LANG_ISODer 2-stellige ISO-Sprachkode des Abonnenten
(z.B. „DE“ = Deutsch).
SUBSC_EMAILDie E-Mail-Adresse des Abonnenten.
SUBSC_EMAILT_CODEE-Mail-Format des Abonnenten.
(„HTML“, „HTMLPLUS“ oder „PLAIN“).

Optional:

SUBSC_ADDRESSDie Adresse des Abonnenten.
SUBSC_CNTR_ISODer zweistellige Länderkode (ISO) des Abonnenten (z.B. „CH“ = Schweiz).
SUBSC_COMPANY_NAMEDer Firmenname des Abonnenten.
SUBSC_CITYDer Ort oder Stadt des Abonnenten.
SUBSC_CNRDie externe Referenznummer des Abonnenten
(z.B. Kundennummer).
SUBSC_BIRTHDAYDer Geburtstag des Abonnenten.
SUBSC_ZIPCODEDie Postleitzahl des Abonnenten.
SUBSC_POBOXDie Postfach-Nr. des Abonnenten.
SUBSC_PHONEDie Telefonnummer des Abonnenten.
SUBSC_FAXDie Faxnummer des Abonnenten.
SUBSC_WIRELESS_PHONEDie Mobilnummer des Abonnenten.
SUBSC_FREE01_TXTFreitextfeld 1 (Typ Text)
SUBSC_FREE01_HTMLFreitextfeld 1 (Typ HTML)
SUBSC_FREE01_PLAINFreitextfeld 1 (Typ Plain)
SUBSC_FREE02_TXTFreitextfeld 2 (Typ Text)
SUBSC_FREE02_HTMLFreitextfeld 2 (Typ HTML)
SUBSC_FREE02_PLAINFreitextfeld 2 (Typ Plain)
SUBSC_FREE03_TXTFreitextfeld 3 (Typ Text)
SUBSC_FREE03_HTMLFreitextfeld 3 (Typ HTML)
SUBSC_FREE03_PLAINFreitextfeld 3 (Typ Plain)
SUBSC_FREE04_TXTFreitextfeld 4 (Typ Text)
SUBSC_FREE04_HTMLFreitextfeld 4 (Typ HTML)
SUBSC_FREE04_PLAINFreitextfeld 4 (Typ Plain)
SUBSC_FREE05_TXTFreitextfeld 5 (Typ Text)
SUBSC_FREE05_HTMLFreitextfeld 5 (Typ HTML)
SUBSC_FREE05_PLAINFreitextfeld 5 (Typ Plain)

SOAP 1.1

Der folgende Code zeigt die XML-Darstellung für ein Subscriber-Objekt.

  1. <tem:subscriber>
  2.     <may:SUBSC_ACC_UUID>xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx</may:SUBSC_ACC_UUID>
  3.     <may:SUBSC_ADDRESS></may:SUBSC_ADDRESS>
  4.     <may:SUBSC_BIRTHDAY>1975-01-01</may:SUBSC_BIRTHDAY>
  5.     <may:SUBSC_CITY>Köln</may:SUBSC_CITY>
  6.     <may:SUBSC_CNR></may:SUBSC_CNR>
  7.     <may:SUBSC_CNTR_ISO>DE</may:SUBSC_CNTR_ISO>
  8.     <may:SUBSC_COMPANY_NAME>Mayoris AG</may:SUBSC_COMPANY_NAME>
  9.     <may:SUBSC_EMAIL>christian.weber@mayoris.com</may:SUBSC_EMAIL>
  10.     <may:SUBSC_EMAILT_CODE>HTML</may:SUBSC_EMAILT_CODE>
  11.     <may:SUBSC_FAX></may:SUBSC_FAX>
  12.     <may:SUBSC_FIRSTNAME>Christian</may:SUBSC_FIRSTNAME>
  13.     <may:SUBSC_FREE01_HTML></may:SUBSC_FREE01_HTML>
  14.     <may:SUBSC_FREE01_PLAIN></may:SUBSC_FREE01_PLAIN>
  15.     <may:SUBSC_FREE01_TXT></may:SUBSC_FREE01_TXT>
  16.     <may:SUBSC_FREE02_HTML></may:SUBSC_FREE02_HTML>
  17.     <may:SUBSC_FREE02_PLAIN></may:SUBSC_FREE02_PLAIN>
  18.     <may:SUBSC_FREE02_TXT></may:SUBSC_FREE02_TXT>
  19.     <may:SUBSC_FREE03_HTML></may:SUBSC_FREE03_HTML>
  20.     <may:SUBSC_FREE03_PLAIN></may:SUBSC_FREE03_PLAIN>
  21.     <may:SUBSC_FREE03_TXT></may:SUBSC_FREE03_TXT>
  22.     <may:SUBSC_FREE04_HTML></may:SUBSC_FREE04_HTML>
  23.     <may:SUBSC_FREE04_PLAIN></may:SUBSC_FREE04_PLAIN>
  24.     <may:SUBSC_FREE04_TXT></may:SUBSC_FREE04_TXT>
  25.     <may:SUBSC_FREE05_HTML></may:SUBSC_FREE05_HTML>
  26.     <may:SUBSC_FREE05_PLAIN></may:SUBSC_FREE05_PLAIN>
  27.     <may:SUBSC_FREE05_TXT></may:SUBSC_FREE05_TXT>
  28.     <may:SUBSC_GNDT_CODE>M</may:SUBSC_GNDT_CODE>
  29.     <may:SUBSC_LANG_ISO>DE</may:SUBSC_LANG_ISO>
  30.     <may:SUBSC_LASTNAME>Weber</may:SUBSC_LASTNAME>
  31.     <may:SUBSC_PHONE></may:SUBSC_PHONE>
  32.     <may:SUBSC_POBOX></may:SUBSC_POBOX>
  33.     <may:SUBSC_UUID>xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx</may:SUBSC_UUID>
  34.     <may:SUBSC_WIRELESS_PHONE></may:SUBSC_WIRELESS_PHONE>
  35.     <may:SUBSC_ZIPCODE>50667</may:SUBSC_ZIPCODE>
  36. </tem:subscriber>

Theme

Das Objekt Theme enthält alle Informationen zu einem Thema/Channel.

Attribute

Hier ist eine Liste aller Attribute des Objekts Theme. Wenn nicht speziell angegeben, sind alle Felder Pflichtfelder.

THM_UUIDDie interne Themen-UUID.
THM_ACC_UUIDDie zugeordnete Account-UUID des Themas.
THM_ACC_NAMEDer Account-Name des Themas.
THM_SEQIDDie Sequenz-ID des Themas
THM_NAMEDer Name des Themas.
THM_DESCDie Beschreibung des Themas
THM_PUBLIC_ACTIVEGibt an, ob das Thema öffentlich ist.

SOAP 1.1

Der folgende Code zeigt die XML-Darstellung für ein Theme Objekt.

  1. <a:Theme>
  2.     <a:THM_ACC_NAME>Testaccount</a:THM_ACC_NAME>
  3.     <a:THM_ACC_UUID>xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx</a:THM_ACC_UUID>
  4.     <a:THM_DESC/>
  5.     <a:THM_PUBLIC_ACTIVE>true</a:THM_PUBLIC_ACTIVE>
  6.     <a:THM_NAME>Testthema</a:THM_NAME>
  7.     <a:THM_SEQID>1</a:THM_SEQID>
  8.     <a:THM_UUID>xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx</a:THM_UUID>
  9. </a:Theme>

Auf dieser Seite

Account
Subscriber
Theme
  • Certified Senders Alliance
  • Certified Senders Alliance
  • swiss made software
  • SAP