Package list

Overview

After you access the XML API Reference, a table appears. The table includes the full package list and corresponding descriptions of all of the packages that are available using the XML interface. Click on a package link in the table for a general description of the package and the information model diagram.

The package list is also available from the upper left panel of the HTML document. When you choose All Classes/Structs/Types, or a specific package name from the list of packages, the content of the class, struct, and types list area in the lower left panel changes. Each package may contain classes, structs, types, or all.

The information model is a UML drawing that shows the relationships amongst the classes in the selected package and other extended classes from which some properties, methods, and naming are inherited. The classes in the package are represented by white rectangles; the extended classes are represented by gray rectangles. When you click on one of the rectangles, the class information about the selected class is displayed.

Most packages have only one information model drawing. However, some of the larger packages (such as service, equipment, and sas) group member classes into separate information models that represent specific functional areas.

For example, the service package provides specifications for all of the areas that affect service creation, maintenance, configuration, and testing. As a result, the information model for the package is divided into more than one information model to address the following functional areas:

  • Access Interface

  • Connector and Composite Service

  • GNE Info

  • Base Service

  • Logical Interface

  • Operational Group and Encap Group

  • STM Service Action

  • STM Service Ping

  • STM Service Trace

  • SAP Policer and Policy Override

The $core package, which is a root or base of all of the packages, defines the base classes and types that all of the other classes use to inherit from. Perform To view release-specific XML schema changes to view package information in the XML API Reference.