Zum Aufbau der Referenz

Die Request- und Response-Elemente sind in diesem Handbuch nach Anwendungsbereichen geordnet. In den meisten Fällen entspricht ein Anwendungsbereich einer Klasse (wie der Klasse der Benutzer oder der Dateien). Jeder Bereich beginnt mit einem Definitionsabschnitt, der den zum Bereich gehörenden Ausschnitt aus CRUL enthält. An dieser Stelle werden gegebenenfalls auch Besonderheiten der CMS-Daten in diesem Bereich genannt. Der nächste Abschnitt führt die Parameterelemente des Bereichs auf. Neben einer Beschreibung jedes Parameters findet man hier auch die entsprechenden Parameter-Definitionen aus der CRUL-DTD.

Anschließend werden die zum jeweiligen Anwendungsbereich gehörenden Funktionselemente beschrieben. Auch hier ist für jedes Element der entsprechende Ausschnitt aus CRUL abgedruckt. Die Aufgaben der Elemente werden erläutert und die Rückgabewerte in Responses spezifiziert. Viele Einzelbeschreibungen der Funktionselemente sind zum besseren Verständnis mit Zusatzinformationen oder Erläuterungen zu speziellen Unterelementen versehen. Ferner sind die Rechte aufgeführt, die ein Benutzer haben muss, um das jeweilige Element in einem Request verwenden zu können. Für jedes Element wird ein Beispiel für seine Verwendung in einem Request und in einer Response gegeben.