10. Dezember 2021

· Whitepaper

GetCentralSectionsOfDirectory

Inhaltsverzeichnis

xx Kapitel

Auslesen zentraler Inhalte eines Ordners

Die Methode GetCentralSectionsOfDirectory ermöglicht es, alle zentralen Inhalte für einen angebebenen Pfad auszulesen.

Request Properties

Path
Gibt an, für welchen Ordner die zentralen Inhalte ausgelesen werden sollen.
Der Pfad muss im folgenden Format angegeben werden:
„[Mandanten Name]/[Ordner]/[Unterordner1]/[Unterordner2]“
Typ der Eigenschaft: String

StatusOfCentralSections
Gibt an, nach welchem Status die zentralen Inhalte des Ordners gefiltert werden sollen.
Die Übergabe von NULL bedeutet keine Filterung – alle zentralen Inhalte werden zurückgegeben.
Bei Übergabe eines Status (Online, Draft, Archive) werden nur die zentralen Inhalte mit genau diesem Status geladen.
Typ der Eigenschaft: CentralSectionStatus (Enum mit den Werten: Online, Draft, Archive)

Beispiel Request „Zentrale Inhalte eines Ordners auslesen“

Der folgende Request liefert für den Pfad „account\sub-folder“ alle zentralen Inhate des Ordners „sub-folder“ zurück.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/GetCentralSectionsOfDirectory
{
  "request": {
    "Language":"DE",
    "SecurityContext": {
      "Account":"account",
      "Username":"username",
      "Password":"*****",
      "Source":"application name"
    },
    "Path":"account\sub-folder",
    "StatusOfCentralSections": NULL
  }
}

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:GetCentralSectionsOfDirectory >
      <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:Path>account\sub-folder</ser:Path>
        <ser:StatusOfCentralSections xsi:nil="true" />
      </ser:request>
    </ser:GetCentralSectionsOfDirectory>
  </soap:Body>
</soap:Envelope>

Response Objekt

Sections
Enthält ein CentralSection Array mit allen zentralen Inhalten, die im angegebenen Ordner enthalten sind und dem mitgelieferten Status Filter entsprechen.